ja-JP/HPEOACmdlets.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOACertificate</command:name> <maml:description> <maml:para>Adds a CA, HP SIM, LDAP, RemoteSupport, or User certificate to the command line.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOACertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOACertificate cmdlet adds a CA, HP SIM, LDAP, RemoteSupport, or User certificate to the command line. A list of connection objects must be provided as parameter. OA administrator access is required to execute this cmdlet.</maml:para> <maml:para>NOTE: Add-HPEOACertificate is only available in script mode. When the Onboard Administrator is operating in FIPS mode, the minimum RSA key length is 2048 bits, and the signature hash algorithm must be SHA-224, SHA-256, SHA-384, or SHA-512.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOACertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Certificate</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Possible values are CA, HPSIM, LDAP, RemoteSupport and User. Specifies the type of certificate that is to be added to the command line. If the value is not set to 'User', then the value for Username parameter is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the username to which the certificate is to be mapped for setting user certificate. This parameter is optional when Type is not 'User'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies the certificate text. The certificate text must appear within start and end markers. The certificate text cannot exceed 3071 characters for all types except user certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOACertificate requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>To import the OA SSL certificate use the Start-HPEOACertificateDownload cmdlet and select type as "OA".</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOACertificate -Connection $connection -Type CA -Certificate $certificate</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Type and Certificate.</maml: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:\> Add-HPEOACertificate -Connection $connection Type not provided... Use same Type for all Connections? (y/n): y Please enter Type (Acceptable values are User, HPSIM, CA, RemoteSupport, LDAP): CA Certificate not provided... Use same Certificate for all Connections? (y/n): y Please enter Certificate: @" -----BEGIN CERTIFICATE----- MIICHzCCAYgCCQCc00bW5VoGGjANBgkqhkiG9w0BAQQFADBUMRgwFgYDVQQKEw9I ZXdsZXR0LVBhY2thcmQxHjAcBgNVBAsTFU9uYm9hcmQgQWRtaW5pc3RyYXRvcjEY MBYGA1UEAxMPT0EtMDAyMjY0MzQ1MTc1MB4XDTA5MTIxNjExNTkxNFoXDTE5MTIx NDExNTkxNFowVDEYMBYGA1UEChMPSGV3bGV0dC1QYWNrYXJkMR4wHAYDVQQLExVP bmJvYXJkIEFkbWluaXN0cmF0b3IxGDAWBgNVBAMTD09BLTAwMjI2NDM0NTE3NTCB nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAogAsUaI7gcsFwfT3LvALb9MdYbGk /ZeJGcpgv4BAbG1BFbf9IYzeoCgLWyTZ0EMuVTB54IIdDS7G01iU8MJPLK/Yk0Cf Jh0SxMGWHH0uTdm4DggjZuonhjntPi7kquElI2gDuh4TPxPqa/v53ojDNlD5oaBW jKpjtQaUmXzWPCMCAwEAATANBgkqhkiG9w0BAQQFAAOBgQAhzJ7/cLAcIWkVmaMl 7FpAyOgnijaq240QPurM2GZVTojDPw0yJwtCTlth9xsFxf3P4w9r4WfBbcYkkg3N EBEYHrTsxD/9sC1f1oqNjxL/Jtw6y9CrcpfTMkfPN+p3Jgxr/MJ+IP4i1NH8I6iV 2IjIJF74pDop4Z4MqCQFuJbu9g== -----END CERTIFICATE----- "@ </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Type and Certificate are not provided, you are prompted to input the values.</maml: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:\> $connection | Add-HPEOACertificate -Type CA -Certificate $certificate</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPEOACertificateDownload</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPEOACertificateGeneration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOACertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOACACertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOALDAPCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOACertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOAUserCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOADNS</command:name> <maml:description> <maml:para>Adds an IP address of a DNS server to the list of DNS servers.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOADNS</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOADNS cmdlet adds an IP address of a DNS server to the list of DNS servers. DNS servers are used if the system is configured to use a static IP address. When the Onboard Administrator is configured for both IPv4 and IPv6, the Onboard Administrator uses the first three valid DNS servers from those configured for the supported network configuration modes in the following order: - Static IPv4 - Static IPv6 - DHCPv4 - DHCPv6</maml:para> <maml:para>If a bay number is not specified, then the command defaults to the active Onboard Administrator. A maximum of two DNS servers can be added. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOADNS</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address of the DNS server to be added to the list of DNS servers. The IP address must be in the form ###.###.###.###, where each ### ranges from 0 to 255 or ####:####:####:####:####:####:####:#### or ####:####:####:####:####:####:####:####/### (with a prefix), where each #### ranges from 0 to FFFF and the prefix /### ranges from 0 to 128.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the Onboard Administrator for which the DNS is set. The default value Active will be used if it is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Active</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOADNS requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOADNS -Connection $connection -IP fe80::444:64ff:fe34:5175/64 -Bay active</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with IP and Bay.</maml: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:\> Add-HPEOADNS -Connection $connection IP not provided... Use same IP for all Connections? (y/n): n Please enter IP for 192.168.241.254: 15.15.15.15 Please enter IP for 192.168.242.64: 16.16.16.16 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the IP parameter is not provided, you are prompted to input the values. If the bay parameter is not specified, the command defaults to the active Onboard Administrator.</maml: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:\> $connection | Add-HPEOADNS -IP fe80::444:64ff:fe34:5175/64 –Bay active</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOAEBIPA</command:name> <maml:description> <maml:para>Adds a DNS server IP address to the list of DNS servers.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOAEBIPA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOAEBIPA cmdlet adds a DNS server IP address to the list of DNS servers. A list of connection objects must be provided as a parameter. Administrator or operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOAEBIPA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target device type for which the DNS server is being added to the list of DNS servers. Possible values are Server and Interconnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>IP address to be added to the list of DNS servers. This is IPv4 or IPv6 IP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the target device for which the DNS IP address is being added to the list of DNS servers. Either a specific bay number is added or a list of bay numbers can be added using - or, (<Bay number> | <bay number> [,|-<bay number>]). The default value All is used if it is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOAEBIPA requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOAEBIPA -Connection $connection -Target Server -IP fe80::333:64ff:fe34:5175 -Bay 1-3</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Target, IP, and Bay.</maml: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:\> Add-HPEOAEBIPA -Connection $connection Target not provided... Use same Target for all Connections? (y/n): y Please enter Target (Acceptable values are Server,Interconnect): Interconnect IP not provided... Use same IP for all Connections? (y/n): n Please enter IP for 192.168.241.254: 15.15.15.15 Please enter IP for 192.168.242.64: 16.16.16.16 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Target and IP parameters are not provided, you are prompted to input the values. If the bay parameter is not specified, the IP DNS server will be added to all servers or interconnects.</maml: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:\> $connection | Add-HPEOAEBIPA -Target Server -IP fe80::333:64ff:fe34:5175</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEOAEBIPA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOAEBIPA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPEOAEBIPA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOAEBIPA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOAIPv6Address</command:name> <maml:description> <maml:para>Adds an IPv6 static address for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOAIPv6Address</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOAIPv6Address cmdlet adds an IPv6 static address for the Onboard Administrator. If IPv6 is enabled, this setting takes effect immediately. If no Onboard Administrator number is provided, the command defaults to the active Onboard Administrator. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOAIPv6Address</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the Onboard Administrator for which the static IP is to be added. Default value “Active” will be used if it is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>Static IP address to be added to the onboard administrator. The IP must be in the form ####:####:####:####:####:####:####:####/###, where each #### ranges from 0 to FFFF and the prefix /### ranges from 0 to 128. The prefix length is mandatory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOAIPv6Address requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOAIPv6Address -Connection $connection -IP fe80::555:64ff:fe34:5175/64 -Bay active</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with IP and Bay.</maml: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:\> Add-HPEOAIPv6Address -Connection $connection IP not provided... Use same IP for all Connections? (y/n): n Please enter IP for 192.168.241.254: fe80::555:64ff:fe34:5175/64 Please enter IP for 192.168.242.64: fe80::555:64ff:fe34:5175/65 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the IP parameter is not provided, you are prompted to input the values. If the bay parameter is not specified, the command defaults to the active Onboard Administrator.</maml: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:\> $connection | Add-HPEOAIPv6Address -IP fe80::555:64ff:fe34:5175/64</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOAIPv6Address</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOALanguage</command:name> <maml:description> <maml:para>Uploads and installs a language pack.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOALanguage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOALanguage cmdlet uploads and installs a language pack. Supported protocols are HTTP, FTP, TFTP, and USB. The URL should be formatted as protocol://host/path/file. The URL syntax for IPv6 addresses is protocol://[<ipv6_address>]/path/file. If your FTP server does not support anonymous connections, then you can specify a username and password by replacing the host part in the previous format with username:password@host.</maml:para> <maml:para>OA Administrator and OA Operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOALanguage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>Specifies the URL from where the language pack is to be downloaded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOALanguage requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOALanguage -Connection $connection -URL "ftp://192.168.243.56/oazh.lpk"</dev:code> <dev:remarks> <maml:para>This example uses the basic parameters to add a language pack. Parameters in this example must be provided.</maml: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:\> Add-HPEOALanguage -Connection $connection URL not provided... Please enter URL: ftp://192.168.243.56/oazh.lpk </dev:code> <dev:remarks> <maml:para>This example adds a language pack using interactive input.</maml: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:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "URL"="ftp://192.168.243.56/oazh.lpk"} PS C:\> $p | Add-HPEOALanguage </dev:code> <dev:remarks> <maml:para>This example adds a language pack in pipeline.</maml: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>PS C:\> $connection | Add-HPEOALanguage -URL "ftp://192.168.243.56/oazh.lpk"</dev:code> <dev:remarks> <maml:para>This example adds a language pack using pipeline and command-line parameters.</maml: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>PS C:\> $connection | Add-HPEOALanguage URL not provided... Please enter URL: ftp://192.168.243.56/oazh.lpk </dev:code> <dev:remarks> <maml:para>This example adds a language pack using pipeline and interactive input.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOALanguage</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOALanguage</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOALDAPBay</command:name> <maml:description> <maml:para>Assigns one or more bays to a specified LDAP group.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOALDAPBay</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOALDAPBay cmdlet provides access to the bay at the access level of the group. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOALDAPBay</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Group</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target device type for which the access is provided to the specified LDAP group. Possible values are 'Server' and 'Interconnect'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number or list of bay numbers for which LDAP is given access. The bay number(s) can be specified as (ALL | Bay number|<bay number> [,|-<bay number>]). If a bay is presently assigned to a user, you must unassign the bay first.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>LDAP group name to which the bay is assigned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOALDAPBay requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOALDAPBay -Connection $connection -Target Server -Group ldap1 -Bay 1-4</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Target, Group and Bay.</maml: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:\> Add-HPEOALDAPBay -Connection $connection Target not provided... Use same Target for all Connections? (y/n): y Please enter Target (Accept values are Server,Interconnect): Interconnect Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 1-4 Group not provided... Use same Group for all Connections? (y/n): n Please enter Group for 192.168.241.254: ldap1 Please enter Group for 192.168.242.64: ldap2 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Target, Bay and Group are not provided, you are prompted to input the values.</maml: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:\> $connection | Add-HPEOALDAPBay -Target Server -Bay 1-4 -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOALDAPBay</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOALDAPGroup</command:name> <maml:description> <maml:para>Adds an LDAP group to the list of LDAP groups.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOALDAPGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOALDAPGroup cmdlet adds an LDAP group to the list of LDAP groups. This group must match a group in the directory server. The maximum number of LDAP groups is 30. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOALDAPGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>LDAP group name from the directory server to be added. Group name must be 1 to 255 characters in length. Character set includes all printable characters, except quotation marks and new lines. The group name must start with an alpha character.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOALDAPGroup requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOALDAPGroup -Connection $connection -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Group.</maml: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:\> Add-HPEOALDAPGroup -Connection $connection Group not provided... Use same Group for all Connections? (y/n): n Please enter Group for 192.168.241.254: ldap2 Please enter Group for 192.168.242.64: ldap3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Group parameter is not provided, you are prompted to input the values.</maml: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:\> $connection | Add-HPEOALDAPGroup -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOALDAPGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOALDAPGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOALDAPPrivilege</command:name> <maml:description> <maml:para>Provides the specified group with access to the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOALDAPPrivilege</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOALDAPPrivilege cmdlet provides the specified group with access to the Onboard Administrator. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOALDAPPrivilege</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>LDAP group to which is assigned access to the OA. Group name must be 1 to 255 characters in length. Character set includes all printable characters, except quotation marks and new lines. The group name must start with an alpha character.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOALDAPPrivilege requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOALDAPPrivilege -Connection $connection -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Group.</maml: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:\> Add-HPEOALDAPPrivilege -Connection $connection Group not provided... Use same Group for all Connections? (y/n): n Please enter Group for 192.168.241.254: ldap2 Please enter Group for 192.168.242.64: ldap3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Group parameter is not provided, you are prompted to input the values.</maml: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:\> $connection | Add-HPEOALDAPPrivilege -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOALDAPPrivilege</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOASNMPTrapReceiver</command:name> <maml:description> <maml:para>Adds a new SNMP Trap receiver to the SNMP configuration.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOASNMPTrapReceiver </command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOASNMPTrapReceiver cmdlet adds a new SNMP Trap receiver to the SNMP configuration. Defaults for the traps are version v1 and port 162. A maximum of eight IP addresses can be added to receive SNMP traps.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOASNMPTrapReceiver</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Host</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>CommunityName</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineId</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>SNMPv3</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Privilege</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>InformEvent</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Host</maml:name> <maml:description> <maml:para>Specifies the trap receiver address for SNMP. The value can be an IPv4 address, an IPv6 address, or a DNS name (maximum of 64 characters). IPv6 addresses must be typed without the network prefix length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>The SNMP Trap community string is set to public or the optional <community name>. The <community name> string, if specified, must be 1 to 20 characters in length. Acceptable characters include any printable character excluding quotes and newlines.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>An SNMPv3 user account used to send the trap/inform. This parameter is used only for version 3. If the value is provided for other versions it will be ignored.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineID</maml:name> <maml:description> <maml:para>Sets the engine ID for the user account. If set, the engine ID must be a series of hexadecimal characters, up to 32 bytes or 64 characters in length. This parameter is used for creating remote accounts used with Inform messages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>SNMPv3</maml:name> <maml:description> <maml:para>Specifies a switch parameter to indicate version number. If this parameter is set, then SNMP v3 traps are allowed. If this parameter is set, The Host and Username parameters are needed; Privilege and InformEvent and EngineId parameters are optional. If this parameter is not set and Host is provided, only CommunityName is optional, Username/Privilege/InformEvent/EngineId are not needed.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Privilege</maml:name> <maml:description> <maml:para>Specifies the minimal level of security required for operation. By default, operation is required to be signed but not encrypted (authNoPriv). The following are valid values: - NOAUTHNOPRIV: No authorization or encryption - AUTHNOPRIV: Authorization but no encryption - AUTHPRIV: Authorization and encryption</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>InformEvent</maml:name> <maml:description> <maml:para>Specifies a switch parameter to indicate whether it's 'Inform' type. If the parameter is set, the event will be 'Inform'; otherwise it will use default value which is 'Trap'.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOASNMPTrapReceiver requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOASNMPTrapReceiver -Connection $connection -Host "1.1.1.1"</dev:code> <dev:remarks> <maml:para>This example shows one way to use the basic parameters to add an SNMP Trap Receiver. Parameters in this example must be provided. Also you can use more parameters to specify the users.</maml: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:\> Add-HPEOASNMPTrapReceiver -Connection $connection -Host "1.1.1.1" -Username "UserA" -SNMPv3 | fl * IP : 192.168.242.64 Hostname : southwind.company.net StatusType : Warning StatusMessage : Warning: SNMPv3 trap created but user UserA not found. </dev:code> <dev:remarks> <maml:para>This example shows another way to use the basic parameters to add an SNMP Trap Receiver. Parameters in this example must be provided. Also you can use more parameters to specify the users. Depending on the OA firmware version, OA may support the command in example 1, the command in example 2, or both.</maml: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:\> Add-HPEOASNMPTrapReceiver -Connection $connection Host not provided... Please enter Host: 2.2.2.2 </dev:code> <dev:remarks> <maml:para>This example adds an SNMP Trap Receiver using interactive input.</maml: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>PS C:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "Host"="3.3.3.3" } PS C:\> $p | Add-HPEOASNMPTrapReceiver </dev:code> <dev:remarks> <maml:para>This example adds an SNMP Trap Receiver in pipeline.</maml: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>PS C:\> $connection | Add-HPEOASNMPTrapReceiver –Host “4.4.4.4”</dev:code> <dev:remarks> <maml:para>This example adds an SNMP Trap Receiver using pipeline and command-line parameters.</maml: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>PS C:\> $connection | Add-HPEOASNMPTrapReceiver Host not provided... Please enter Host:5.5.5.5 </dev:code> <dev:remarks> <maml:para>This example adds an SNMP Trap Receiver using pipeline and interactive input.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOASNMPTrapReceiver</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOASNMPUser</command:name> <maml:description> <maml:para>Creates a new user to be used for SNMP v3 queries, traps and informs.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOASNMPUser </command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOASNMPUser cmdlet creates a new user to be used for SNMP v3 queries, traps and informs. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOASNMPUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>AuthPassphraseEncoding</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>AuthPassphrase</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""> <maml:name>PrivacyPassphraseEncoding</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PrivacyPassphrase</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SecurityLevel</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineId</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>ReadWriteAccess</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies an SNMPv3user account used to send the trap or inform event. It is an alphanumeric string upto 32 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>AuthPassphraseEncoding</maml:name> <maml:description> <maml:para>Possible values are MD5 or SHA1. These are the encoding algorithms to encode the authorization passphrase. MD5 is not allowed when FIPS mode is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>AuthPassphrase</maml:name> <maml:description> <maml:para>Specifies the authorization passphrase used to sign operations. This entry must be atleast eight characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""> <maml:name>PrivacyPassphraseEncoding</maml:name> <maml:description> <maml:para>Possible values are DES or AES128. Use DES or AES128 algorithm to encode the privacy passphrase. DES iss not allowed when FIPS mode is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PrivacyPassphrase</maml:name> <maml:description> <maml:para>Specifies the privacy passphrase to encrypt operations. This entry must be at least eight characters in length. If not specified, the authorization passphrase is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SecurityLevel</maml:name> <maml:description> <maml:para>Specifies the minimum level of security required for operation. By default, operation is required to be signed but not encrypted. Possible values are: - NoAuthNoPriv – No authorization or encryption - AuthNoPriv – Authorization but no encryption - AuthPriv – Authorization and encryption</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineId</maml:name> <maml:description> <maml:para>Sets the engine ID for the user account. If set, the engine ID must be a series of hexadecimal characters, up to 32 bytes or 64 characters in length. This parameter is used for creating remote accounts used with Inform messages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>ReadWriteAccess</maml:name> <maml:description> <maml:para>Specifies a SwitchParameter to indicate whether this user has read/write access to the OID tree. If not specified, the user has read-only access.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOASNMPUser requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOASNMPUser -Connection $connection -Username "UserA" -AuthPassphraseEncoding MD5 -AuthPassphrase "passwordForUserA" -PrivacyPassphraseEncoding DES </dev:code> <dev:remarks> <maml:para>This example uses the basic parameters to create an SNMP user. Parameters in this example must be provided. Also you can use more parameters to create SNMP users.</maml: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:\> Add-HPEOASNMPUser -Connection $connection Username not provided... Please enter Username: UserB AuthPassphraseEncoding not provided... Please enter AuthPassphraseEncoding (Acceptable values are MD5, SHA1): MD5 AuthPassphrase not provided... Please enter AuthPassphrase: passwordForUserB PrivacyPassphraseEncoding not provided... Please enter PrivacyPassphraseEncoding (Acceptable values are AES128, DES): DES </dev:code> <dev:remarks> <maml:para>The example creates an SNMP user using interactive input.</maml: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:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "Username"="UserC"; "AuthPassphraseEncoding"="MD5"; "AuthPassphrase"="passwordForUserc"; "PrivacyPassphraseEncoding"="DES" } PS C:\> $p | Add-HPEOASNMPUser </dev:code> <dev:remarks> <maml:para>This example creates an SNMP user in pipeline.</maml: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>PS C:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "AuthPassphraseEncoding"="MD5"; "AuthPassphrase"="passwordForUserD"; "PrivacyPassphraseEncoding"="DES" } PS C:\> $p | Add-HPEOASNMPUser -Username "UserD" </dev:code> <dev:remarks> <maml:para>This example creates an SNMP user using pipeline and command-line parameters.</maml: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>PS C:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "AuthPassphraseEncoding"="MD5"; "AuthPassphrase"="passwordForUserE"; "PrivacyPassphraseEncoding"="DES" } PS C:\> $p | Add-HPEOASNMPUser Username not provided... Please enter Username: UserE </dev:code> <dev:remarks> <maml:para>This example creates an SNMP user using pipeline and interactive input.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOASNMPUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOASNMPUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOASSHKey</command:name> <maml:description> <maml:para>Adds an SSH key or keys to the Administrator local account.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOASSHKey </command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOASSHKey cmdlet adds an SSH key or keys to the Administrator local account. Multiple SSHKEYs can be concatenated in the string.SSHKEY is only available for the Administrator local account and works only in script mode.</maml:para> <maml:para>SSHKEY string is limited to 4KB on OA versions prior to 2.30. SSHKEY string is limited to 8KB on OA version 2.30 and later.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOASSHKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Key</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Key</maml:name> <maml:description> <maml:para>SSH key to be added to the onboard administrator account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOASSHKey requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOASSHKey -Connection $connection -Key $key</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> Add-HPEOASSHKey -Connection $connection Key not provided... Use same Key for all Connections? (y/n): y Please enter Key: westwind.company.net ssh-dss AAAAB3NzaC1kc3MAAACBAPaKFi+Gg0xZ9IccAMpvkAAhtd1K1GdHoMw3PRM1OhkrrU9x2/SZ9YQDSqM8t6VUQV76pxZfbeemdIPdRelRJu4ue2akTSuaQIubLAwG7uzUtr7PR7Ft4SiT0RNTJiqMHrLV9Xsrd8OZKgMHK69fOwYxoUxY7bG+ixZccbRHqHnVAAAAFQDUZ7Tu6s8bcGxokBzu14+RibVTLQAAAIAkprdsNIu7m0Hl2H7zT4aEHSwi2rNwFYC1ZwzoBTQMSf086wW7CxEM4p6WWxkCrPHZnWQ7DHi2yuvLVHO2R3no3YUIV6Vb8j06ps2DeFzC8lzVCULlvKpLg4I+9OHV2yZN/13Y6xPefV646/KlHXKZ7ILB9BNcZ+aUfyMEiWe+CwAAAIEA2QLsK9p/Fmmn4WPE3+aPeJm51EBISfiZ1mrGWvCcASB/9NXLhFvPLxthqbjxHUfg+VZs0xyQyarJcr0UvQE2kXkUvalFN5YxALbQm7USmNaks21IAsk24d1NgPAiUplgNg/EIB9lp5SaHfsxhUJrBqH0WL2bvKgjOYJI/S/+ivw= </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.Because the parameter Key is not input, you are prompted to input the values.</maml: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:\> $server | Add-HPEOASSHKey</dev:code> <dev:remarks> <maml:para>In this example $server including Connection, Key information is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOASSHKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEOASSHKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPEOASSHKeyDownload</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOATrustedHost</command:name> <maml:description> <maml:para>Adds a new IPv4 or IPv6 address to the list of addresses being handled by the IP Security feature.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOATrustedHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOATrustedHost cmdlet adds a new IPv4 or IPv6 address to the list of addresses being handled by the IP Security feature. You can add a maximum of five IP addresses to the IP Manager. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOATrustedHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address of the trusted host being handled by IP security.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOATrustedHost requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOATrustedHost -Connection $connection -IP 192.168.240.23</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with IP.</maml: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:\> Add-HPEOATrustedHost -Connection $connection IP not provided... Use same IP for all Connections? (y/n): n Please enter IP for 192.168.241.254: fe80::555:64ff:fe34:5175/64 Please enter IP for 192.168.242.64: 192.168.240.18 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the IP parameter is not provided, you are prompted to input the values.</maml: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:\> $connection | Add-HPEOATrustedHost -IP 192.168.240.23</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOATrustedHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEOATrustedHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOAUser</command:name> <maml:description> <maml:para>Adds a user to the system.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOAUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOAUser cmdlet adds a user to the system. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOAUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Password</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>The Username is case sensitive and must be unique to all other user names and group names. The Username must be 1 to 40 characters long and can include all alphanumeric characters, the dash, and the underscore. The Username must begin with a letter. Reserved user names are: ALL (case insensitive) ADMINISTRATOR (case insensitive), switch1, switch2, switch3, switch4, switch5, switch6, switch7, switch8, ldapuser, and nobody.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>The Password must be three to eight characters long for firmware 1.00 through 1.30 and 3 to 40 characters long for firmware 2.00 and later. The character set includes all printable characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOAUser requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOAUser -Connection $connection -Username user1 -Password password_user1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Username and Password.</maml: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:\> Add-HPEOAUser -Connection $connection Username not provided... Use same Username for all Connections? (y/n): n Please enter Username for 192.168.241.254: user2 Please enter Username for 192.168.242.64: user3 Password not provided... Use same Password for all Connections? (y/n): n </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Username and Password are not provided, you are prompted to input the values.</maml: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:\> $connection | Add-HPEOAUser -Username user1 -Password password_user1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOAUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOAUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOAUserBay</command:name> <maml:description> <maml:para>Assigns one or more bays to a user.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOAUserBay</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOAUserBay cmdlet assigns one or more bays to a user. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOAUserBay</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target device type of the bay which is being assigned to the user. Possible values are Server and Interconnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the target device(s) which is being assigned to the user. The bay number can be specified as (ALL | Bay number|<bay number> [,|-<bay number>]). If a bay is presently assigned to a user, you must unassign the bay first.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>Username which is given access to the specified bay. The Username is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOAUserBay requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOAUserBay -Connection $connection -Target Interconnect -Bay 1-3 -Username user1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Target, Bay, and Username.</maml: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:\> Add-HPEOAUserBay -Connection $connection Target not provided... Use same Target for all Connections? (y/n): y Please enter Target (Acceptable values are Server, Interconnect): server Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 1-3 Username not provided... Use same Username for all Connections? (y/n): n Please enter Username for 192.168.241.254: user2 Please enter Username for 192.168.242.64: user3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Target, Bay, and Username are not provided, you are prompted to input the values. </maml: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:\> $connection | Add-HPEOAUserBay -Target Interconnect -Bay 1-3 -Username user1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOAUserBay</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOAUserPrivilege</command:name> <maml:description> <maml:para>Assigns the Onboard Administrators specified to an existing user.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOAUserPrivilege</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOAUserPrivilege cmdlet assigns the Onboard Administrators specified to an existing user. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOAUserPrivilege</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>Username which is given access to the OA. The Username is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOAUserPrevilege requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOAUserPrivilege -Connection $connection -Username user1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Username.</maml: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:\> Add-HPEOAUserPrivilege -Connection $connection Username not provided... Use same Username for all Connections? (y/n): n Please enter Username for 192.168.241.254: user2 Please enter Username for 192.168.242.64: user3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Username parameter is not provided, you are prompted to input the values.</maml: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:\> $connection | Add-HPEOAUserPrivilege -Username user1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOAUserPrivilege</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-HPEOAVLAN</command:name> <maml:description> <maml:para>Creates a VLAN ID and an optional VLAN Name.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOAVLAN</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOAVLAN cmdlet creates a VLAN ID and an optional VLAN Name. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-HPEOAVLAN</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Name</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <maml:description> <maml:para>Newly created VLAN ID. An integer from 1 to 4094.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the VLAN that is created. Limited to 31 alphanumeric characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Add-HPEOAVLAN requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOAVLAN -Connection $connection -VLANID 2 -Name name_vlan2</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with VLANID and Name.</maml: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:\> Add-HPEOAVLAN -Connection $connection VLANID not provided... Use same VLANID for all Connections? (y/n): n Please enter VLANID for 192.168.241.254: 3 Please enter VLANID for 192.168.242.64: 4 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the VLANID parameter is not provided, you are prompted to input the values. Because the Name parameter is optional, you are not prompted to input the value even if not provided.</maml: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:\> $connection | Add-HPEOAVLAN -VLANID 2 -Name name_vlan2</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOAVLAN</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOAVLAN</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-HPEOALoginBannerText</command:name> <maml:description> <maml:para>Clears the currently configured login banner text.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEOALoginBannerText</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEOALoginBannerText cmdlet clears the currently configured login banner text. Clearing the login banner text disables the login banner option. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet. The cmdlet is not available on OA 3.x.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-HPEOALoginBannerText</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Clear-HPEOALoginBannerText requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Clear-HPEOALoginBannerText -Connection $connection </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Clear-HPEOALoginBannerText</dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOALoginBannerText</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEOALoginBannerText</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-HPEOANTP</command:name> <maml:description> <maml:para>Disables access to the Primary or Secondary NTP server.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEOANTP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEOANTP cmdlet disables access to the Primary or Secondary NTP server. Clearing the Primary NTP server disables NTP. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-HPEOANTP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>NTP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>NTP</maml:name> <maml:description> <maml:para>The NTP server to which access is disabled. Possible values are Primary and Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Clear-HPEOANTP requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Clear-HPEOANTP -Connection $connection -NTP Primary</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with NTP.</maml: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:\> Clear-HPEOANTP -Connection $connection NTP not provided... Use same NTP for all Connections? (y/n): y Please enter NTP: Secondary </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the NTP parameter is not provided, you are prompted to input the values.</maml: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:\> $connection | Clear-HPEOANTP -NTP Primary</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEOANTP</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-HPEOASSHKey</command:name> <maml:description> <maml:para>Removes the authorized key file used for SSH login.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEOASSHKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEOASSHKey cmdlet removes the authorized key file used for SSH login. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-HPEOASSHKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Clear-HPEOASSHKey requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Clear-HPEOASSHKey -Connection $connection</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection | Clear-HPEOASSHKey</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOASSHKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-HPEOASysLog</command:name> <maml:description> <maml:para>Clears the Onboard Administrator system log.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEOASysLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEOASysLog cmdlet clears the Onboard Administrator system log.</maml:para> <maml:para>CAUTION. You cannot restore this information after you delete it.</maml:para> <maml:para>If you do not specify a bay number, the Active Onboard Administrator system log is cleared. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-HPEOASysLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Type</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of Syslog to be cleared. Possible values are Enclosure and OA.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the Onboard Administrator for which the SysLogs are to be cleared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Clear-HPEOASysLog requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Clear-HPEOASysLog -Connection $connection -Type OA -Bay active</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Type and Bay.</maml: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:\> Clear-HPEOASysLog -Connection $connection</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Type and Bay are optional, you are not prompted to input the values even if not provided.</maml: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:\> $connection | Clear-HPEOASysLog -Type Enclosure</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOASysLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-HPEOAVCMode</command:name> <maml:description> <maml:para>Clears Virtual Connect Mode settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEOAVCMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEOAVCMode cmdlet clears Virtual Connect Mode settings. All servers in the enclosure should be powered off before clearing the VCMODE. The enclosure will no longer be managed by Virtual Connect, and servers will revert to default Ethernet MAC and Fibre Channel WWN assignments. Virtual Connect might disconnect the servers from Ethernet networks and Fibre Channel fabrics.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-HPEOAVCMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Clear-HPEOAVCMod requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Clear-HPEOAVCMode -Connection $connection</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection| Clear-HPEOAVCMode</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOAVCMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-HPEOA</command:name> <maml:description> <maml:para>Connects to an OA and creates an SSH session.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>HPEOA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Connect-HPEOA cmdlet creates an SSH session to the Onboard Administrator IP / Hostname specified by logging on using the Username and Password provided by the user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-HPEOA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Host,OAHost,Hostname,IP,IPAddr"> <maml:name>OA</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Password</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Credential</maml:name> <command:parameterValue required="false" variableLength="false">PSCredential, PSObject, list of PSCredential and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Timeout</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Port</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Host,OAHost,Hostname,IP,IPAddr"> <maml:name>OA</maml:name> <maml:description> <maml:para>OA IP / Hostname to create a session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>User name to log onto the OA. Username needs to be input together with Password. Username should not be used along with Credential.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the OA. Password needs to be input together with Username. Password should not be used along with Credential.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential object based on user name and password to log onto the OA. Credential should not be used along with Username/Password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential, PSObject, list of PSCredential and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>45</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Time value after which the client connection times out. The value is specified in seconds. The default value is 45.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>45</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para>The network port at which the SSH connection to the OA is used for communication. The default value is 22.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>22</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Connect-HPEOA requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, connection object to OA is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEOA –OA 192.168.242.64 –Username Administrator –Password Admin –Port 22 –Timeout 30 PS C:\> $connection |fl ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : 00:00:00 </dev:code> <dev:remarks> <maml:para>This example creates a connection to OA which is stored in $connection object. The output in this case is a single object of type Renci.SshNet.SshClient which is used for executing cmdlets on the OA. Timeout mentioned is in seconds.</maml: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:\> $connection = Connect-HPEOA –OA 192.168.242.62 –Username Administrator –Password Admin PS C:\> $connection |fl ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : 00:00:00 </dev:code> <dev:remarks> <maml:para>This example creates a connection to OA which is stored in $connection object. The output in this case is a single object of type Renci.SshNet.SshClient. Because Port and Timeout values are not provided, default values of 22 and 45 are used for Port and Timeout respectively.</maml: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:\> $credential = Get-Credential -Message "Please input username and password" PS C:\> $connection = Connect-HPEOA -OA 192.168.242.62 -Credential $credential PS C:\> $connection | fl ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : -00:00:00.0010000 </dev:code> <dev:remarks> <maml:para>This example creates a connection to OA which is stored in $connection object. The output in this case is a single object of type Renci.SshNet.SshClient. Credential is used to create the connection. Since Port and Timeout values are not provided, default values of 22 and 45 are used for Port and Timeout respectively..</maml: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>PS C:\> $temp = New-Object PSObject $temp | Add-Member OA 192.168.242.64 $temp | Add-Member Username Administrator $temp | Add-Member Password Admin $connection = $temp | Connect-HPEOA PS C:\> $connection |fl ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : 00:00:00 </dev:code> <dev:remarks> <maml:para>This example creates a Renci.SshNet.SshClient object in $connection variable. This variable can be used with other cmdlets as value for Connection parameter.</maml: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>PS C:\> $connection = Connect-HPEOA –OA "192.168.242.62-64" –Username Administrator –Password Admin PS C:\> $connection |fl ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : 00:00:00 ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : 00:00:00 ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : 00:00:00 </dev:code> <dev:remarks> <maml:para>This example creates a list of Renci.SshNet.SshClient objects in $connection variable. If other cmdlets are executed with this variable as Connection parameter, the cmdlet will be executed on the three OAs.</maml: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>PS C:\> $credential = Get-Credential -Message "Please input username and password" $temp = New-Object PSObject $temp | Add-Member OA 192.168.242.64 $temp | Add-Member Credential $credential $connection = $temp | Connect-HPEOA PS C:\> $connection | fl ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : -00:00:00.0010000 </dev:code> <dev:remarks> <maml:para> Credential is used when creating the connection. This example creates a Renci.SshNet.SshClient object in $connection variable. This variable can be used with other cmdlets as value for Connection parameter.</maml: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>PS C:\> $credential = Get-Credential -Message "Please input username and password." PS C:\> $connection = Connect-HPEOA –OA "192.168.242.62-64" -Credential $credential PS C:\> $connection | fl ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : -00:00:00.0010000 ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : -00:00:00.0010000 ForwardedPorts : {} ConnectionInfo : Renci.SshNet.PasswordConnectionInfo IsConnected : True KeepAliveInterval : -00:00:00.0010000 </dev:code> <dev:remarks> <maml:para> Credential is used when creating the connection. This example creates a list of Renci.SshNet.SshClient objects in $connection variable. If other cmdlets are executed with this variable as Connection parameter, the cmdlet will be executed on the three OAs.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-HPEOACRL</command:name> <maml:description> <maml:para>Disables certificate revocation checks.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEOACRL</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPEOACRL cmdlet disables certificate revocation checks. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-HPEOACRL</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Disable-HPEOACRL requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Disable-HPEOACRL -Connection $connection </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter.</maml: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:para> </maml:introduction> <dev:code> PPS C:\> $connection | Disable-HPEOACRL</dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disconnect-HPEOA</command:name> <maml:description> <maml:para>Closes an SSH session with the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>HPEOA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disconnect-HPEOA cmdlet closes an SSH session with the Onboard Administrator. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-HPEOA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with connection status is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Disconnect-HPEOA –Connection $connection</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It is the SshClient object or a list of SshClient objects that have to be disconnected in the session.</maml: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:\> $connection| Disconnect-HPEOA</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It is a SshClient object or a list of SshClient objects that have to be disconnected in the session.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-HPEOA</command:name> <maml:description> <maml:para>Find list of Onboard Administrators in a specified subnet.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Find</command:verb> <command:noun>HPEOA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Find-HPEOA cmdlet lists valid Onboard Administrators in the subnet provided. You must provide the subnet in which the Onboard Administrators have to be searched.</maml:para> <maml:para>All users are allowed access to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-HPEOA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="IP"> <maml:name>Range</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Timeout</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Role</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="IP"> <maml:name>Range</maml:name> <maml:description> <maml:para>Specifies the lower parts of the IP addresses which is the subnet in which the OAs are being searched. This parameter supports both IPv4 and IPv6. For IPv4 address format 'a.b.c.d', where a, b, c, d represent an integer from 0 to 255, the Range parameter can have values like the following: a – e.g.: 10 - for all IP addresses in 10.0.0.0 to 10.255.255.255 a.b – e.g.: 10.44 - for all IP addresses in 10.44.0.0 to 10.44.255.255 a.b.c – e.g.: 10.44.111 - for all IP addresses in 10.44.111.0 to 10.44.111.255 a.b.c.d - e.g.: 10.44.111.222 - for IP address 10.44.111.222</maml:para> <maml:para>Each division of the IP address, can specify a range using a hyphen. For example: "10.44.111.10-12" returns IP addresses 10.44.111.10, 10.44.111.11, and 10.44.111.12</maml:para> <maml:para>Each division of the IP address, can specify a set using a comma. For example: "10.44.111.10,12" returns IP addresses 10.44.111.10, 10.44.111.12</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout period for ping request. Timeout period can be specified by the user where there can be a possible lag due to geographical distance between client and server. Default value is 3000 which is 3000 milliseconds. If the default timeout is not long enough, no OAs will be found and no errors will be displayed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role type of OA to find out. Possible values are "All", "Active", and "Standby". Default value is "All".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Find-HPEOA -Range "192.168.242.62-63,64" Warning : It might take a while to search all the HPE OA servers if the input is a very large range. Use Verbose for more information. IP : 192.168.242.62 Hostname : eastwind.company.net ProductName : c3000 Tray with embedded DDR2 Onboard Administrator Firmware : 3.11 Role : STANDBY SerialNumber : PAMMT0C9VXA09J UUID : 18PAMMT0C9VXA09J IP : 192.168.242.63 Hostname : westwind.company.net ProductName : BladeSystem c7000 DDR2 Onboard Administrator with KVM Firmware : 4.22 Role : ACTIVE SerialNumber : OB93BP0215 UUID : 09OB93BP0215 IP : 192.168.242.64 Hostname : southwind.company.net ProductName : c3000 Tray with embedded DDR2 Onboard Administrator Firmware : 3.30 Role : ACTIVE SerialNumber : PAMMT0A9VWY01N UUID : 18PAMMT0A9VWY01N </dev:code> <dev:remarks> <maml:para>This example shows the basic way to use Find-HPEOA. You can get more information using the Verbose parameter.</maml: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:\> Find-HPEOA "2607:f0d0:1002:51::0-FFFF" -Role Active</dev:code> <dev:remarks> <maml:para>This example lists the IP addresses of active OAs ranging from 2607:f0d0:1002:51::0 to 2607:f0d0:1002:51::FFFF.</maml: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:\> Find-HPEOA "6.4.217" -Timeout 1000</dev:code> <dev:remarks> <maml:para>This example lists the IP addresses of OAs ranging from 6.4.217.0 to 6.4.217.255 and the timeout for ping response will be 1000 milliseconds. </maml: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>PS C:\> Find-HPEOA "6.4.." -Timeout 1000 -Role Standby</dev:code> <dev:remarks> <maml:para>This example lists the IP addresses of standby OAs ranging from 6.4.0.0 to 6.4.255.255.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOABladeDeviceSerialNumber</command:name> <maml:description> <maml:para>Gets the specified direct attached blade device serial number.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOABladeDeviceSerialNumber</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOABladeDeviceSerialNumber cmdlet gets the specified direct attached blade device serial number. A list of connection objects must be provided as a parameter. All users with access to specified bay can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOABladeDeviceSerialNumber</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Specifies the bay of the blade device for which the serial number is to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOABladeDeviceSerialNumber requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS C:\> Get-HPEOABladeDeviceSerialNumber -Connection $connection -Bay $bay IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK SerialNumber : USP7120KDE IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK SerialNumber : USE951W9JE </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with bay.</maml: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-HPEOABladeDeviceSerialNumber -Connection $connection Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 5 IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK SerialNumber : USP7120KDE IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK SerialNumber : USE951W9JE </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, you are prompted to input the values.</maml: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:\> $connection |Get-HPEOABladeDeviceSerialNumber -Bay $bay IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK SerialNumber : USP7120KDE IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK SerialNumber : USE951W9JE </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOACACertificate</command:name> <maml:description> <maml:para>Gets a list of installed CA certificates.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOACACertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOACACertificate cmdlet gets a list of installed CA certificates. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOACACertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOACACertificate requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS C:\> Get-HPEOACACertificate -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK CaCertificates : {@{CertificateVersion=1; IssuerOrganization=Hewlett-Packard; IssuerOrganizationalUnit=Onboard Administrator; IssuerCommonName=OA-002264345175; SubjectOrganization=Hewlett-Packard; SubjectOrganizationalUnit=Onboard Administrator; SubjectCommonName=OA-002264345175; ValidFrom=2009-12-16T11:59:14Z; ValidTo=2019-12-14T11:59:14Z; SerialNumber=9C:D3:46:D6:E5:5A:06:1A; ExtensionCount=0; Md5Fingerprint=96:57:11:AD:DE:A7:14:2A:6E:DC:14:E9:40:9C:85:B4; Sha1Fingerprint=7A:3A:8E:04:D7:B8:1D:32:4E:D9:FD:95:38:27:71:98:8B:3D:9A:21; CaCertificateName=CaCertificate 1}, @{CertificateVersion=3; IssuerOrganization=GlobalSign nv-sa; IssuerOrganizationalUnit=Root CA; IssuerCommonName=GlobalSign Root CA; SubjectOrganization=GlobalSign nv-sa; SubjectOrganizationalUnit=Root CA; SubjectCommonName=GlobalSign Root CA; ValidFrom=1998-09-01T12:00:00Z; ValidTo=2028-01-28T12:00:00Z; SerialNumber=04:00:00:00:00:01:15:4B:5A:C3:94; ExtensionCount=3; Md5Fingerprint=3E:45:52:15:09:51:92:E1:B7:5D:37:9F:B1:87:29:8A; Sha1Fingerprint=B1:BC:96:8B:D4:F4:9D:62:2A:A8:9A:81:F2:15:01:52:A4:1D:82:9C; CaCertificateName=CaCertificate 2}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK CaCertificates : {@{CertificateVersion=1; IssuerOrganization=Hewlett-Packard; IssuerOrganizationalUnit=Onboard Administrator; IssuerCommonName=OA-002264345175; SubjectOrganization=Hewlett-Packard; SubjectOrganizationalUnit=Onboard Administrator; SubjectCommonName=OA-002264345175; ValidFrom=2009-12-16T11:59:14Z; ValidTo=2019-12-14T11:59:14Z; SerialNumber=9C:D3:46:D6:E5:5A:06:1A; ExtensionCount=0; Md5Fingerprint=96:57:11:AD:DE:A7:14:2A:6E:DC:14:E9:40:9C:85:B4; Sha1Fingerprint=7A:3A:8E:04:D7:B8:1D:32:4E:D9:FD:95:38:27:71:98:8B:3D:9A:21; CaCertificateName=CaCertificate 1}, @{CertificateVersion=3; IssuerOrganization=GlobalSign nv-sa; IssuerOrganizationalUnit=Root CA; IssuerCommonName=GlobalSign Root CA; SubjectOrganization=GlobalSign nv-sa; SubjectOrganizationalUnit=Root CA; SubjectCommonName=GlobalSign Root CA; ValidFrom=1998-09-01T12:00:00Z; ValidTo=2028-01-28T12:00:00Z; SerialNumber=04:00:00:00:00:01:15:4B:5A:C3:94; ExtensionCount=3; Md5Fingerprint=3E:45:52:15:09:51:92:E1:B7:5D:37:9F:B1:87:29:8A; Sha1Fingerprint=B1:BC:96:8B:D4:F4:9D:62:2A:A8:9A:81:F2:15:01:52:A4:1D:82:9C; CaCertificateName=CaCertificate 2}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOACACertificate IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK CaCertificates : {@{CertificateVersion=1; IssuerOrganization=Hewlett-Packard; IssuerOrganizationalUnit=Onboard Administrator; IssuerCommonName=OA-002264345175; SubjectOrganization=Hewlett-Packard; SubjectOrganizationalUnit=Onboard Administrator; SubjectCommonName=OA-002264345175; ValidFrom=2009-12-16T11:59:14Z; ValidTo=2019-12-14T11:59:14Z; SerialNumber=9C:D3:46:D6:E5:5A:06:1A; ExtensionCount=0; Md5Fingerprint=96:57:11:AD:DE:A7:14:2A:6E:DC:14:E9:40:9C:85:B4; Sha1Fingerprint=7A:3A:8E:04:D7:B8:1D:32:4E:D9:FD:95:38:27:71:98:8B:3D:9A:21; CaCertificateName=CaCertificate 1}, @{CertificateVersion=3; IssuerOrganization=GlobalSign nv-sa; IssuerOrganizationalUnit=Root CA; IssuerCommonName=GlobalSign Root CA; SubjectOrganization=GlobalSign nv-sa; SubjectOrganizationalUnit=Root CA; SubjectCommonName=GlobalSign Root CA; ValidFrom=1998-09-01T12:00:00Z; ValidTo=2028-01-28T12:00:00Z; SerialNumber=04:00:00:00:00:01:15:4B:5A:C3:94; ExtensionCount=3; Md5Fingerprint=3E:45:52:15:09:51:92:E1:B7:5D:37:9F:B1:87:29:8A; Sha1Fingerprint=B1:BC:96:8B:D4:F4:9D:62:2A:A8:9A:81:F2:15:01:52:A4:1D:82:9C; CaCertificateName=CaCertificate 2}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK CaCertificates : {@{CertificateVersion=1; IssuerOrganization=Hewlett-Packard; IssuerOrganizationalUnit=Onboard Administrator; IssuerCommonName=OA-002264345175; SubjectOrganization=Hewlett-Packard; SubjectOrganizationalUnit=Onboard Administrator; SubjectCommonName=OA-002264345175; ValidFrom=2009-12-16T11:59:14Z; ValidTo=2019-12-14T11:59:14Z; SerialNumber=9C:D3:46:D6:E5:5A:06:1A; ExtensionCount=0; Md5Fingerprint=96:57:11:AD:DE:A7:14:2A:6E:DC:14:E9:40:9C:85:B4; Sha1Fingerprint=7A:3A:8E:04:D7:B8:1D:32:4E:D9:FD:95:38:27:71:98:8B:3D:9A:21; CaCertificateName=CaCertificate 1}, @{CertificateVersion=3; IssuerOrganization=GlobalSign nv-sa; IssuerOrganizationalUnit=Root CA; IssuerCommonName=GlobalSign Root CA; SubjectOrganization=GlobalSign nv-sa; SubjectOrganizationalUnit=Root CA; SubjectCommonName=GlobalSign Root CA; ValidFrom=1998-09-01T12:00:00Z; ValidTo=2028-01-28T12:00:00Z; SerialNumber=04:00:00:00:00:01:15:4B:5A:C3:94; ExtensionCount=3; Md5Fingerprint=3E:45:52:15:09:51:92:E1:B7:5D:37:9F:B1:87:29:8A; Sha1Fingerprint=B1:BC:96:8B:D4:F4:9D:62:2A:A8:9A:81:F2:15:01:52:A4:1D:82:9C; CaCertificateName=CaCertificate 2}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOACertificate</command:name> <maml:description> <maml:para>Gets the certificate information for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOACertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOACertificate cmdlet gets the certificate information for the Onboard Administrator, CA, RemoteSupport, and LDAP. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOACertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Possible values are CA, LDAP, RemoteSupport, and OA. Specifies the type of required certificate. If Type is specified as OA, the Bay parameter is needed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the Onboard Administrator for which the certificate details are to be retrieved. Value can be specified as All|<Bay number>|<bay number>[,|- <bay number>] | Active | StandBy. Default value for this parameter is Active.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Active</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOACertificate requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOACertificate -Connection $connection -Type OA -Bay $bay IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{IsPresent=No; Bay=1}, @{IssuedBy=ESOIRONSIDE1-CA; ValidFrom=2014-04-09T17:49:07Z; ValidUntil=2015-04-09T17:59:07Z; SerialNumber=19:16:41:85:00:00:00:00:00:02; Version=3; MD5Fingerprint=58:CB:01:2C:B3:9C:EB:E1:A3:C3:B0:D4:D8:7D:61:7C; SHA1Fingerprint=4A:93:7D:55:2F:32:87:8B:CA:0A:9C:BD:57:EF:E1:83:6E:17:14:8F; CommonName=OA-00237D5E710D; Country=CN; StateOrProvince=Chongqing; CityOrLocality=Chongqing; OrganizationName=Hewlett-Packard; OrganizationalUnit=Onboard Administrator; Bay=2}} IP : 192.168.242.64 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{IsPresent=No; Bay=1}, @{IssuedBy=OA-002264345175; ValidFrom=2014-07-24T18:01:28Z; ValidUntil=2024-07-21T18:01:28Z; SerialNumber=C7:0C:A8:29:F4:58:17:51; Version=1; MD5Fingerprint=12:F0:31:25:92:04:6C:9F:CD:04:7C:A3:76:27:8C:2A; SHA1Fingerprint=E7:C5:C4:2F:16:0F:34:07:82:C4:A5:4D:E8:E7:5A:A0:F0:0F:D5:86; PublicKey=RSA (2048 Bits); CommonName=OA-002264345175; Country=; StateOrProvince=; CityOrLocality=; OrganizationName=Hewlett-Packard; OrganizationalUnit=Onboard Administrator; Bay=2}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Type and Bay.</maml: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:\> $connection | Get-HPEOACertificate -Connection $connection Type not provided... Use same Type for all Connections? (y/n): y Please enter Type (Acceptable values are CA,RemoteSupport,OA,LDAP): CA IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : No CA certificates are imported. IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK CaCertificate : {@{CertificateVersion=3; IssuerOrganization=; IssuerOrganizationalUnit=; IssuerCommonName=ca0; SubjectOrganization=; SubjectOrganizationalUnit=; SubjectCommonName=ca0; ValidFrom=2014-03-28T14:59:22Z; ValidTo=2019-03-27T14:59:22Z; SerialNumber=84:87:35:D9:39:F0:FF:6A; ExtensionCount=3; Md5Fingerprint=80:4B:1C:03:71:2F:B5:B4:9F:15:20:D1:1D:D9:A4:94; Sha1Fingerprint=2D:68:7D:26:2B:5F:3C:05:FF:9A:2D:53:DA:F7:20:88:10:F0:82:DA; CaCertificateNumber=1}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter. If the parameter Type’s value is not provided, you are asked to input the value. </maml: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:\> $connection | Get-HPEOACertificate –Type LDAP IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK LDAPCertificate : {@{IssuedTo=Southking; MD5Fingerprint=FD:74:FD:4D:2E:EB:73:A4:E1:D8:80:E6:58:60:D5:48; CertificateContent=-----BEGIN CERTIFICATE----- MIICfzCCAegCCQDpMAOSpyrU+TANBgkqhkiG9w0BAQsFADCBgzESMBAGA1UEAxMJ U291dGhraW5nMQswCQYDVQQGEwJDTjESMBAGA1UECBMJQ2hvbmdxaW5nMRIwEAYD VQQHEwlDaG9uZ3FpbmcxGDAWBgNVBAoTD0hld2xldHQtUGFja2FyZDEeMBwGA1UE CxMVT25ib2FyZCBBZG1pbmlzdHJhdG9yMB4XDTE0MDQwOTA3MzYwOVoXDTI0MDQw NjA3MzYwOVowgYMxEjAQBgNVBAMTCVNvdXRoa2luZzELMAkGA1UEBhMCQ04xEjAQ BgNVBAgTCUNob25ncWluZzESMBAGA1UEBxMJQ2hvbmdxaW5nMRgwFgYDVQQKEw9I ZXdsZXR0LVBhY2thcmQxHjAcBgNVBAsTFU9uYm9hcmQgQWRtaW5pc3RyYXRvcjCB nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAogAsUaI7gcsFwfT3LvALb9MdYbGk /ZeJGcpgv4BAbG1BFbf9IYzeoCgLWyTZ0EMuVTB54IIdDS7G01iU8MJPLK/Yk0Cf Jh0SxMGWHH0uTdm4DggjZuonhjntPi7kquElI2gDuh4TPxPqa/v53ojDNlD5oaBW jKpjtQaUmXzWPCMCAwEAATANBgkqhkiG9w0BAQsFAAOBgQCQENJVFz+Uurv0r7RV h+h3Q9/O1JcDTLq9PxwJUXWS9SmCR+UZ289xK8cV/9GWfrNArWH+gtFL2fwqUyUG VKDMs//1fACsN+nkJZ2SIl58T37pMZ6jpR+7ubtpFVYGEBPurRnbXavRSfruqygr dH84sOV5skqjayB+u80iXFewuQ== -----END CERTIFICATE----- }} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK LDAPCertificate : {@{IssuedTo=OA-002481A4862D; MD5Fingerprint=53:8B:BA:CA:B9:8F:80:CC:F2:5C:D7:26:E0:80:52:7F; CertificateContent=-----BEGIN CERTIFICATE----- MIICHzCCAYgCCQDSVPR6qsMZzTANBgkqhkiG9w0BAQQFADBUMRgwFgYDVQQKEw9I ZXdsZXR0LVBhY2thcmQxHjAcBgNVBAsTFU9uYm9hcmQgQWRtaW5pc3RyYXRvcjEY MBYGA1UEAxMPT0EtMDAyNDgxQTQ4NjJEMB4XDTA2MDYxNDAwMDEwMloXDTE2MDYx MTAwMDEwMlowVDEYMBYGA1UEChMPSGV3bGV0dC1QYWNrYXJkMR4wHAYDVQQLExVP bmJvYXJkIEFkbWluaXN0cmF0b3IxGDAWBgNVBAMTD09BLTAwMjQ4MUE0ODYyRDCB nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA37xqnY3GUE4Og4C4jL4fvdttFNPu bCj1gxy25GOb0MjRn5AUA1Z62IH1lMxDpzat/EKUg22e1gTybTVdzClPlLR0chdK 432dsm32Ig7HJO//3oX8KWVl6QpS7oYaUVB0ppWOs3OHD5RbIU73V/e+GNra9Q9b E/tczdu/2Vq+3DcCAwEAATANBgkqhkiG9w0BAQQFAAOBgQCXunPKEAASFcXjYXzQ EO16J3g8j4MnpI0Sl2foWg7nQLhgcI1BjmX5XTddJ+zoawG5y4t+1g8mT/ChNE1w 53fqdY8L77iydMZj3UsJ08zR62I/XlFtT/cgM6asl2fq115BP0gfw8hN1fZPcQ20 6wKTBaV++2vq+NLFy7xlunKD9g== -----END CERTIFICATE----- }} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAConfig</command:name> <maml:description> <maml:para>Gets the script required to recreate the settings of the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAConfig cmdlet gets the script required to recreate the settings of the enclosure. Passwords are not included for any user. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAConfig requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAConfig -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Config : {#Script Generated by Administrator, #Generated on: Thu May 15 20:34:41 2014, , ...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Config : {#Script Generated by Administrator, #Generated on: Thu May 15 22:56:25 2014, , ...} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAConfig IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Config : {#Script Generated by Administrator, #Generated on: Thu May 15 20:42:54 2014, , ...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Config : {#Script Generated by Administrator, #Generated on: Thu May 15 23:05:09 2014, , ...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOADate</command:name> <maml:description> <maml:para>Gets the current date, time, and time zone of the internal clock of the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOADate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOADate cmdlet gets the current date, time, and time zone of the internal clock of the enclosure. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOADate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOADate requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOADate -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Date : 5/12/2014 7:59:33 AM TimeZone : US/Pacific IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Date : 11/13/2014 9:40:54 AM TimeZone : Etc/GMT-8 </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOADate IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Date : 5/12/2014 7:59:33 AM TimeZone : US/Pacific IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Date : 11/13/2014 9:40:54 AM TimeZone : Etc/GMT-8 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEBIPA</command:name> <maml:description> <maml:para>Gets EBIPA information.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEBIPA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEBIPA cmdlet gets EBIPA information. A list of connection objects must be provided as a parameter. OA Administrator, Operator, or User access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEBIPA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>IPv6</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParamter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>IPv6</maml:name> <maml:description> <maml:para>Switch parameter that gets EBIPA v6 settings. If it is present, this command will show EBIPAv6 settings only, otherwise, it gets EBIPAv4 settings only.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEBIPA requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEBIPA -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EBIPADeviceServerSettings : {@{Bay=1; Enabled=No; EBIPA=; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=192.175.135.52, 192.175.135.51; Domain=}, @{Bay=1A; Enabled=No; EBIPA=; Current=; Netmask=; Gateway=; DNS=; Domain=}, @{Bay=1B; Enabled=No; EBIPA=; Current=; Netmask=; Gateway=; DNS=; Domain=}, @{Bay=2; Enabled=No; EBIPA=; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=192.175.135.52, 192.175.135.51, 192.175.135.53; Domain=}...} EBIPADeviceInterconnectSettings : {@{Bay=1; Enabled=No; EBIPA=; Current=0.0.0.0; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=2; Enabled=No; EBIPA=; Current=192.168.246.113; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=3; Enabled=No; EBIPA=; Current=192.168.246.242; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=4; Enabled=No; EBIPA=; Current=192.168.247.254; Netmask=; Gateway=; DNS=; NTP=; Domain=}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EBIPADeviceServerSettings : {@{Bay=1; Enabled=Yes; EBIPA=192.168.243.100; Current=192.168.243.178; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=192.175.135.52, 192.175.135.51; Domain=xxxxxx}, @{Bay=1A; Enabled=Yes; EBIPA=192.168.243.116; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=; Domain=xxxxx}, @{Bay=1B; Enabled=Yes; EBIPA=192.168.243.132; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=; Domain=xxxxx}, @{Bay=2; Enabled=Yes; EBIPA=192.168.243.101; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=; Domain=xxxxx}...} EBIPADeviceInterconnectSettings : {@{Bay=1; Enabled=No; EBIPA=; Current=192.168.244.127; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=2; Enabled=No; EBIPA=; Current=192.168.244.161; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=3; Enabled=No; EBIPA=; Current=0.0.0.0; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=4; Enabled=No; EBIPA=; Current=192.168.245.86; Netmask=; Gateway=; DNS=; NTP=; Domain=}...} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter without switch parameter IPv6. It shows the EBIPAv4 settings only.</maml: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-HPEOAEBIPA -Connection $connection -IPv6 IP : 192.168.242.62 Hostname : southwind.company.net StatusType : OK StatusMessage : OK EBIPAv6DeviceBladesSettings : @{Bays=System.Management.Automation.PSObject[]} EBIPAv6DeviceInterconnectSettings : @{Bays=System.Management.Automation.PSObject[]} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EBIPAv6DeviceBladesSettings : @{Bays=System.Management.Automation.PSObject[]} EBIPAv6DeviceInterconnectSettings : @{Bays=System.Management.Automation.PSObject[]} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter with switch parameter IPv6. It shows the EBIPAv6 settings only.</maml: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:\> $connection | Get-HPEOAEBIPA IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EBIPADeviceServerSettings : {@{Bay=1; Enabled=No; EBIPA=; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=192.175.135.52, 192.175.135.51; Domain=}, @{Bay=1A; Enabled=No; EBIPA=; Current=; Netmask=; Gateway=; DNS=; Domain=}, @{Bay=1B; Enabled=No; EBIPA=; Current=; Netmask=; Gateway=; DNS=; Domain=}, @{Bay=2; Enabled=No; EBIPA=; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=192.175.135.52, 192.175.135.51, 192.175.135.53; Domain=}...} EBIPADeviceInterconnectSettings : {@{Bay=1; Enabled=No; EBIPA=; Current=0.0.0.0; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=2; Enabled=No; EBIPA=; Current=192.168.246.113; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=3; Enabled=No; EBIPA=; Current=192.168.246.242; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=4; Enabled=No; EBIPA=; Current=192.168.247.254; Netmask=; Gateway=; DNS=; NTP=; Domain=}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EBIPADeviceServerSettings : {@{Bay=1; Enabled=Yes; EBIPA=192.168.243.100; Current=192.168.243.178; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=192.175.135.52, 192.175.135.51; Domain=xxxxxx}, @{Bay=1A; Enabled=Yes; EBIPA=192.168.243.116; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=; Domain=xxxxx}, @{Bay=1B; Enabled=Yes; EBIPA=192.168.243.132; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=; Domain=xxxxx}, @{Bay=2; Enabled=Yes; EBIPA=192.168.243.101; Current=; Netmask=255.255.248.0; Gateway=192.168.240.1; DNS=; Domain=xxxxx}...} EBIPADeviceInterconnectSettings : {@{Bay=1; Enabled=No; EBIPA=; Current=192.168.244.127; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=2; Enabled=No; EBIPA=; Current=192.168.244.161; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=3; Enabled=No; EBIPA=; Current=0.0.0.0; Netmask=; Gateway=; DNS=; NTP=; Domain=}, @{Bay=4; Enabled=No; EBIPA=; Current=192.168.245.86; Netmask=; Gateway=; DNS=; NTP=; Domain=}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEnclosureFan</command:name> <maml:description> <maml:para>Gets information and current status of the specified enclosure fan.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEnclosureFan</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEnclosureFan cmdlet gets information and current status of the specified enclosure fan. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEnclosureFan</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="FanNumber"> <maml:name>Fan</maml:name> <maml:description> <maml:para>Fan number for which the status is to be displayed. All gets status of all the fans. Status can be retrieved for all fans by setting the value of this parameter as All or a specific fan number can be mentioned for retrieving status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="FanNumber"> <maml:name>Fan</maml:name> <maml:description> <maml:para>Fan number for which the status is to be displayed. All gets status of all the fans. Status can be retrieved for all fans by setting the value of this parameter as All or a specific fan number can be mentioned for retrieving status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEnclosureFan requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEnclosureFan -Connection $connection -Fan $fan IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Fan : {@{Status=OK; Speed=27 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=6; ProductName=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; Version=2.3; DiagnosticStatus=; FanNumber=1}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Fan : {@{Status=OK; Speed=41 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=19; ProductName=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; Version=2.7; DiagnosticStatus=; FanNumber=1}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Fan.</maml: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-HPEOAEnclosureFan -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Fan : {@{Status=OK; Speed=27 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=6; ProductName=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; Version=2.3; DiagnosticStatus=; FanNumber=1}, @{Status=OK; Speed=27 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=6; ProductName=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; Version=2.3; DiagnosticStatus=; FanNumber=2}, @{Status=OK; Speed=27 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=6; ProductName=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; Version=2.3; DiagnosticStatus=; FanNumber=3}, @{Status=OK; Speed=27 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=5; ProductName=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; Version=2.3; DiagnosticStatus=; FanNumber=4}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Fan : {@{Status=OK; Speed=41 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=18; ProductName=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; Version=2.7; DiagnosticStatus=; FanNumber=1}, @{Status=OK; Speed=33 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=11; ProductName=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; Version=2.7; DiagnosticStatus=; FanNumber=2}, @{Status=OK; Speed=41 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=19; ProductName=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; Version=2.7; DiagnosticStatus=; FanNumber=3}, @{Status=OK; Speed=41 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=15; ProductName=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; Version=2.7; DiagnosticStatus=; FanNumber=4}...} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter. Parameter Fan is not input, so the default value ALL is used and the information of all the fans is displayed.</maml: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:\> $server | Get-HPEOAEnclosureFan IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Fan : {@{Status=OK; Speed=33 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=10; PowerConsumed=11; ProductName=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; Version=2.7; DiagnosticStatus=; FanNumber=1}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Fan : {@{Status=OK; Speed=30 percent of Maximum speed; MaximumSpeed=18000; MinimumSpeed=600; PowerConsumed=15; ProductName=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; Version=2.7; DiagnosticStatus=; FanNumber=2}} </dev:code> <dev:remarks> <maml:para>In this example connection and fan information in $server is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEnclosureInfo</command:name> <maml:description> <maml:para>Gets enclosure information.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEnclosureInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEnclosureInfo cmdlet gets enclosure information. The following enclosure details are displayed: - Enclosure name - Enclosure type - Onboard Administrator hardware version - Enclosure Rack U Position - Enclosure part number - Serial number - Asset tag - Onboard Administrator MAC address </maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEnclosureInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEnclosureInfo requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEnclosureInfo -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosureName : PoseidonC7000_MidC EnclosureType : BladeSystem c7000 Enclosure G2 PartNumber : 507019-B21 SerialNumber : USE921MBJ8 UUID : 09USE921MBJ8 AssetTag : MidplaneSparePartNumber : 519345-001 SolutionsID : 0000000000000000 PowerDistributionUnit : @{PDUType=HP AC Module, Single Phase; PDUSparePartNumber=413494-001} OnboardAdministratorTrayInformation : @{Type=HP BladeSystem c7000 Onboard Administrator Tray; SparePartNumber=519346-001; SerialNumber=O192BP0213} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK EnclosureName : abc EnclosureType : BladeSystem c7000 Enclosure G2 PartNumber : 0123456789 SerialNumber : 1234567890 UUID : 091234567890 AssetTag : cde MidplaneSparePartNumber : 519345-001 SolutionsID : 0000000000000000 PowerDistributionUnit : @{PDUType=HP AC Module, Single Phase; PDUSparePartNumber=413494-001} OnboardAdministratorTrayInformation : @{Type=HP BladeSystem c7000 Onboard Administrator Tray; SparePartNumber=519346-001; SerialNumber=O195BP0093}</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection |Get-HPEOAEnclosureInfo IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosureName : PoseidonC7000_MidC EnclosureType : BladeSystem c7000 Enclosure G2 PartNumber : 507019-B21 SerialNumber : USE921MBJ8 UUID : 09USE921MBJ8 AssetTag : MidplaneSparePartNumber : 519345-001 SolutionsID : 0000000000000000 PowerDistributionUnit : @{PDUType=HP AC Module, Single Phase; PDUSparePartNumber=413494-001} OnboardAdministratorTrayInformation : @{Type=HP BladeSystem c7000 Onboard Administrator Tray; SparePartNumber=519346-001; SerialNumber=O192BP0213} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK EnclosureName : abc EnclosureType : BladeSystem c7000 Enclosure G2 PartNumber : 0123456789 SerialNumber : 1234567890 UUID : 091234567890 AssetTag : cde MidplaneSparePartNumber : 519345-001 SolutionsID : 0000000000000000 PowerDistributionUnit : @{PDUType=HP AC Module, Single Phase; PDUSparePartNumber=413494-001} OnboardAdministratorTrayInformation : @{Type=HP BladeSystem c7000 Onboard Administrator Tray; SparePartNumber=519346-001; SerialNumber=O195BP0093}</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEnclosureLCD</command:name> <maml:description> <maml:para>Gets information about the Insight Display screen.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEnclosureLCD</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEnclosureLCD cmdlet gets information about the Insight Display screen. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEnclosureLCD</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEnclosureLCD requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEnclosureLCD -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Status : OK Display : Blinking Name : BladeSystem c3000 Insight Display SparePart : 519312-001 Manufacturer : HP FwVersion : 2.4.3 DiagnosticStatus : @{InternalData=OK} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Status : OK Display : Blinking Name : BladeSystem c7000 Insight Display SparePart : 441203-001 Manufacturer : HP FwVersion : 2.2.2 DiagnosticStatus : @{InternalData=OK} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAEnclosureLCD IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Status : OK Display : Blinking Name : BladeSystem c3000 Insight Display SparePart : 519312-001 Manufacturer : HP FwVersion : 2.4.3 DiagnosticStatus : @{InternalData=OK} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Status : OK Display : Blinking Name : BladeSystem c7000 Insight Display SparePart : 441203-001 Manufacturer : HP FwVersion : 2.2.2 DiagnosticStatus : @{InternalData=OK} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEnclosurePowerCap</command:name> <maml:description> <maml:para>Gets the current Enclosure Dynamic Power Cap in watts.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEnclosurePowerCap</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEnclosurePowerCap cmdlet gets the current Enclosure Dynamic Power Cap in watts. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEnclosurePowerCap</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEnclosurePowerCap requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEnclosurePowerCap -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EnclosureDynamicPowerCap : Disabled DeratedCircuitCapacity : Disabled RatedCircuitCapacity : Disabled AllowableEnclosureDynamicPowerCap : 889 - 5837 Watts AC AllowableDeratedCircuitCapacity : 889 - 5837 Watts AC AllowableRatedCircuitCapacity : 889 - 5837 Watts AC IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK EnclosureDynamicPowerCap : Disabled DeratedCircuitCapacity : Disabled RatedCircuitCapacity : Disabled AllowableEnclosureDynamicPowerCap : 796 - 1459 Watts AC AllowableDeratedCircuitCapacity : 796 - 1459 Watts AC AllowableRatedCircuitCapacity : 796 - 1459 Watts AC </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAEnclosurePowerCap IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EnclosureDynamicPowerCap : Disabled DeratedCircuitCapacity : Disabled RatedCircuitCapacity : Disabled AllowableEnclosureDynamicPowerCap : 889 - 5837 Watts AC AllowableDeratedCircuitCapacity : 889 - 5837 Watts AC AllowableRatedCircuitCapacity : 889 - 5837 Watts AC IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK EnclosureDynamicPowerCap : Disabled DeratedCircuitCapacity : Disabled RatedCircuitCapacity : Disabled AllowableEnclosureDynamicPowerCap : 796 - 1459 Watts AC AllowableDeratedCircuitCapacity : 796 - 1459 Watts AC AllowableRatedCircuitCapacity : 796 - 1459 Watts AC </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEnclosurePowerCapBaysToExclude</command:name> <maml:description> <maml:para>Gets the bays in the enclosure that are exempt from the Enclosure Dynamic Power Cap.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEnclosurePowerCapBaysToExclude</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEnclosurePowerCapBaysToExclude cmdlet gets the bays in the enclosure that are exempt from the Enclosure Dynamic Power Cap. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEnclosurePowerCapBaysToExclude</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEnclosurePowerCapBaysToExclude requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEnclosurePowerCapBaysToExclude -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EnclosurePowerCapBaysToExclude : None IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosurePowerCapBaysToExclude : 2 </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAEnclosurePowerCapBaysToExclude IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EnclosurePowerCapBaysToExclude : None IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosurePowerCapBaysToExclude : 2 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEnclosurePowerSummary</command:name> <maml:description> <maml:para>Gets a detailed summary of the enclosure present power state.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEnclosurePowerSummary</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEnclosurePowerSummary cmdlet gets a detailed summary of the enclosure present power state. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEnclosurePowerSummary</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEnclosurePowerSummary requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEnclosurePowerSummary -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EnclosureBayOutputAllocation : {@{Bay=Devices; PowerAllocatedWattsDC=0}, @{Bay=Interconnects; PowerAllocatedWattsDC=127}, @{Bay=Fans; PowerAllocatedWattsDC=480}, @{Bay=Total; PowerAllocatedWattsDC=607}} EnclosureOutputPowerSummary : {@{EnclosurePowerCapacityWattsDC=4800; EnclosurePowerAllocationWattsDC=607; EnclosurePowerAvailableWattsDC=4193}} EnclosureInputPowerSummary : {@{EnclosurePresentPowerWattsAC=215; EnclosureMaxInputPowerWattsAC=5836; EnclosureDynamicPowerCapWattsAC=Not Set; EnclosurePowerLimitWattsAC=Not Set}} DeviceBayPowerSummary : {@{Bay=5; Name=HP StorageWorks SB4; PowerAllocatedWattsDC=0}, @{Bay=7; Name=ProLiant BL460c Gen; PowerAllocatedWattsDC=0}, @{Bay=Total; Name=; PowerAllocatedWattsDC=0}} InterconnectBayPowerSummary : {@{Bay=1; Name=HP 1Gb Ethernet Pass-Thru Modul; PowerAllocatedWattsDC=32}, @{Bay=2; Name=GbE2c Ethernet Blade Switch; PowerAllocatedWattsDC=25}, @{Bay=3; Name=HP 8/24c SAN Switch Pwr Pk+ Bla; PowerAllocatedWattsDC=35}, @{Bay=4; Name=HP 8/24c SAN Switch Pwr Pk+ Bla; PowerAllocatedWattsDC=35}...} FanPowerSummary : {@{TotalFansNumberOfFans=6; FanRuleNumberOfFans=6; PresentPowerWattsDC=32; PowerAllocatedWattsDC=480}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosureBayOutputAllocation : {@{Bay=Devices; PowerAllocatedWattsDC=140}, @{Bay=Interconnects; PowerAllocatedWattsDC=560}, @{Bay=Fans; PowerAllocatedWattsDC=500}, @{Bay=Total; PowerAllocatedWattsDC=1200}} EnclosureOutputPowerSummary : {@{EnclosurePowerCapacityWattsDC=9860; EnclosurePowerAllocationWattsDC=1200; EnclosurePowerAvailableWattsDC=8660}} EnclosureInputPowerSummary : {@{EnclosurePresentPowerWattsAC=797; EnclosureMaxInputPowerWattsAC=12000; EnclosureDynamicPowerCapWattsAC=Not Set; EnclosurePowerLimitWattsAC=12000}} DeviceBayPowerSummary : {@{Bay=1; Name=ProLiant BL420c Gen; PowerAllocatedWattsDC=0}, @{Bay=4; Name=ProLiant BL660c Gen; PowerAllocatedWattsDC=140}, @{Bay=7; Name=ProLiant BL460c Gen; PowerAllocatedWattsDC=0}, @{Bay=Total; Name=; PowerAllocatedWattsDC=140}} InterconnectBayPowerSummary : {@{Bay=1; Name=HP 1/10Gb-F VC-Enet Module; PowerAllocatedWattsDC=40}, @{Bay=2; Name=HP 1/10Gb-F VC-Enet Module; PowerAllocatedWattsDC=40}, @{Bay=3; Name=HP 4Gb VC-FC Module; PowerAllocatedWattsDC=40}, @{Bay=4; Name=HP 4Gb VC-FC Module; PowerAllocatedWattsDC=40}...} FanPowerSummary : {@{TotalFansNumberOfFans=10; FanRuleNumberOfFans=10; PresentPowerWattsDC=120; PowerAllocatedWattsDC=500}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAEnclosurePowerSummary IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EnclosureBayOutputAllocation : {@{Bay=Devices; PowerAllocatedWattsDC=0}, @{Bay=Interconnects; PowerAllocatedWattsDC=127}, @{Bay=Fans; PowerAllocatedWattsDC=480}, @{Bay=Total; PowerAllocatedWattsDC=607}} EnclosureOutputPowerSummary : {@{EnclosurePowerCapacityWattsDC=4800; EnclosurePowerAllocationWattsDC=607; EnclosurePowerAvailableWattsDC=4193}} EnclosureInputPowerSummary : {@{EnclosurePresentPowerWattsAC=215; EnclosureMaxInputPowerWattsAC=5836; EnclosureDynamicPowerCapWattsAC=Not Set; EnclosurePowerLimitWattsAC=Not Set}} DeviceBayPowerSummary : {@{Bay=5; Name=HP StorageWorks SB4; PowerAllocatedWattsDC=0}, @{Bay=7; Name=ProLiant BL460c Gen; PowerAllocatedWattsDC=0}, @{Bay=Total; Name=; PowerAllocatedWattsDC=0}} InterconnectBayPowerSummary : {@{Bay=1; Name=HP 1Gb Ethernet Pass-Thru Modul; PowerAllocatedWattsDC=32}, @{Bay=2; Name=GbE2c Ethernet Blade Switch; PowerAllocatedWattsDC=25}, @{Bay=3; Name=HP 8/24c SAN Switch Pwr Pk+ Bla; PowerAllocatedWattsDC=35}, @{Bay=4; Name=HP 8/24c SAN Switch Pwr Pk+ Bla; PowerAllocatedWattsDC=35}...} FanPowerSummary : {@{TotalFansNumberOfFans=6; FanRuleNumberOfFans=6; PresentPowerWattsDC=32; PowerAllocatedWattsDC=480}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosureBayOutputAllocation : {@{Bay=Devices; PowerAllocatedWattsDC=140}, @{Bay=Interconnects; PowerAllocatedWattsDC=560}, @{Bay=Fans; PowerAllocatedWattsDC=500}, @{Bay=Total; PowerAllocatedWattsDC=1200}} EnclosureOutputPowerSummary : {@{EnclosurePowerCapacityWattsDC=9860; EnclosurePowerAllocationWattsDC=1200; EnclosurePowerAvailableWattsDC=8660}} EnclosureInputPowerSummary : {@{EnclosurePresentPowerWattsAC=797; EnclosureMaxInputPowerWattsAC=12000; EnclosureDynamicPowerCapWattsAC=Not Set; EnclosurePowerLimitWattsAC=12000}} DeviceBayPowerSummary : {@{Bay=1; Name=ProLiant BL420c Gen; PowerAllocatedWattsDC=0}, @{Bay=4; Name=ProLiant BL660c Gen; PowerAllocatedWattsDC=140}, @{Bay=7; Name=ProLiant BL460c Gen; PowerAllocatedWattsDC=0}, @{Bay=Total; Name=; PowerAllocatedWattsDC=140}} InterconnectBayPowerSummary : {@{Bay=1; Name=HP 1/10Gb-F VC-Enet Module; PowerAllocatedWattsDC=40}, @{Bay=2; Name=HP 1/10Gb-F VC-Enet Module; PowerAllocatedWattsDC=40}, @{Bay=3; Name=HP 4Gb VC-FC Module; PowerAllocatedWattsDC=40}, @{Bay=4; Name=HP 4Gb VC-FC Module; PowerAllocatedWattsDC=40}...} FanPowerSummary : {@{TotalFansNumberOfFans=10; FanRuleNumberOfFans=10; PresentPowerWattsDC=120; PowerAllocatedWattsDC=500}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEnclosurePowerSupply</command:name> <maml:description> <maml:para>Gets power supply details of the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEnclosurePowerSupply</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEnclosurePowerSupply cmdlet gets power supply details of the enclosure. The following power supply details are displayed: - Power supply status - AC input status - Capacity - Input voltage range #1 (measured in V) - Input voltage range #2 (if necessary; measured in V) - Input frequency range (measured in Hz) - Part number - Serial number - Hardware revision for the specified power supply (if one is specified) - Range of power supplies, or for all power supplies (if ALL is specified)</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEnclosurePowerSupply</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="PowerSupply"> <maml:name>PowerSupplyNumber</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="PowerSupply"> <maml:name>PowerSupplyNumber</maml:name> <maml:description> <maml:para>Specifies the number of enclosure for which the details are to be retrieved. The PowerSupply can be specified as ALL | <power supply number>[{ , | - } <power supply number>].</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEnclosurePowerSupply requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEnclosurePowerSupply -Connection $connection -PowerSupply $powersupply IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK PowerSupply : {@{Status=OK; ACInputStatus=OK; Capacity=1200 Watts; CurrentPowerOutput=0 Watts (Dynamic Power Savings Mode); SerialNumber=5AMJQ0D4DY001O; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=5}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK PowerSupply : {@{Status=Failed; ACInputStatus=Failed; Capacity=0 Watts; CurrentPowerOutput=0 Watts; SerialNumber=531290A4DUY0LW; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=5}}</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with PowerSupply.</maml: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-HPEOAEnclosurePowerSupply -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK PowerSupply : {@{Status=OK; ACInputStatus=OK; Capacity=1200 Watts; CurrentPowerOutput=36 Watts; SerialNumber=5AMJQ0D4DX902X; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=1}, @{Status=OK; ACInputStatus=OK; Capacity=1200 Watts; CurrentPowerOutput=0 Watts (Dynamic Power Savings Mode); SerialNumber=5AMJQ0D4DY001J; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=2}, @{Status=Power Supply Bay Empty; PowerSupplyNumber=3}, @{Status=OK; ACInputStatus=OK; Capacity=1200 Watts; CurrentPowerOutput=36 Watts; SerialNumber=5AMJQ0D4DXB224; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=4}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK PowerSupply : {@{Status=OK; ACInputStatus=OK; Capacity=1200 Watts; CurrentPowerOutput=275 Watts; SerialNumber=5AMJQ0D4DY000T; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=1}, @{Status=OK; ACInputStatus=OK; Capacity=1200 Watts; CurrentPowerOutput=361 Watts; SerialNumber=531290A4DUY112; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=2}, @{Status=Power Supply Bay Empty; PowerSupplyNumber=3}, @{Status=OK; ACInputStatus=OK; Capacity=1200 Watts; CurrentPowerOutput=284 Watts; SerialNumber=5AMJQ0D4DY002Q; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=4}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Parameter PowerSupply is not input so the default value ALL is used, and the information of all the power supplies is displayed.</maml: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:\> $server | Get-HPEOAEnclosurePowerSupply IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK PowerSupply : {@{Status=OK; ACInputStatus=OK; Capacity=1200 Watts; CurrentPowerOutput=0 Watts (Dynamic Power Savings Mode); SerialNumber=5AMJQ0D4DY001O; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=4}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK PowerSupply : {@{Status=Failed; ACInputStatus=Failed; Capacity=0 Watts; CurrentPowerOutput=0 Watts; SerialNumber=531290A4DUY0LW; ProductName=HP PROLIANT SERVER PS; PartNumber=437572-B21; SparePartNumber=441830-001; ProductVer=01; DiagnosticStatus=; PowerSupplyNumber=5}}</dev:code> <dev:remarks> <maml:para>In this example Connection and PowerSupply information in $server is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEnclosureStatus</command:name> <maml:description> <maml:para>Gets the basic health and status of the enclosure subsystem.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEnclosureStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEnclosureStatus cmdlet gets the basic health and status of the enclosure subsystem. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEnclosureStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEnclosureStatus requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEnclosureStatus -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Enclosure : @{Status=Degraded; UnitIdentificationLED=Off; DiagnosticStatus=} OnboardAdministrator : @{Status=OK} PowerSubsystem : @{Status=Degraded; PowerMode=Redundant; RedundancyState=Redundant; PowerCapacity=1200 Watts DC; PowerAvailable=650 Watts DC; PresentPower=249 Watts AC} CoolingSubsystem : @{Status=OK; Good=6; Wanted=6; Needed=5; Fan=System.Management.Automation.PSObject[]} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Enclosure : @{Status=Degraded; UnitIdentificationLED=Off; DiagnosticStatus=} OnboardAdministrator : @{Status=OK} PowerSubsystem : @{Status=OK; PowerMode=Not Redundant; PowerCapacity=13500 Watts DC; PowerAvailable=12300 Watts DC; PresentPower=798 Watts AC} CoolingSubsystem : @{Status=OK; Good=10; Wanted=10; Needed=9; Fan=System.Management.Automation.PSObject[]} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAEnclosureStatus IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Enclosure : @{Status=Degraded; UnitIdentificationLED=Off; DiagnosticStatus=} OnboardAdministrator : @{Status=OK} PowerSubsystem : @{Status=Degraded; PowerMode=Redundant; RedundancyState=Redundant; PowerCapacity=1200 Watts DC; PowerAvailable=650 Watts DC; PresentPower=313 Watts AC} CoolingSubsystem : @{Status=OK; Good=6; Wanted=6; Needed=5; Fan=System.Management.Automation.PSObject[]} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Enclosure : @{Status=Degraded; UnitIdentificationLED=Off; DiagnosticStatus=} OnboardAdministrator : @{Status=OK} PowerSubsystem : @{Status=OK; PowerMode=Not Redundant; PowerCapacity=13500 Watts DC; PowerAvailable=12300 Watts DC; PresentPower=804 Watts AC} CoolingSubsystem : @{Status=OK; Good=10; Wanted=10; Needed=9; Fan=System.Management.Automation.PSObject[]} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAEnclosureTemp</command:name> <maml:description> <maml:para>Gets the highest ambient temperature being reported by the installed blade devices.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAEnclosureTemp</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAEnclosureTemp cmdlet gets the highest ambient temperature being reported by the installed blade devices. If no blade devices are installed, the cmdlet gets the temperature of the Onboard Administrator module as an approximation of the ambient temperature. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAEnclosureTemp</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAEnclosureTemp requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAEnclosureTemp -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EnclosureTemp : {@{Locale=Enclosure; Bay=; TempStatus=OK; Temp=41C/105F; Caution=75C; Critical=80C}, @{Locale=Onboard Administrator; Bay=2; TempStatus=OK; Temp=41C/105F; Caution=75C; Critical=80C}, @{Locale=Blade Bay; Bay=5; TempStatus=N/A; Temp=0C/ 32F; Caution=45C; Critical=60C}, @{Locale=Interconnect Module; Bay=1; TempStatus=OK; Temp=; Caution=; Critical=}...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosureTemp : {@{Locale=Enclosure; Bay=; TempStatus=N/A; Temp=18C/ 64F; Caution=; Critical=}, @{Locale=Onboard Administrator; Bay=1; TempStatus=OK; Temp=36C/ 96F; Caution=75C; Critical=80C}, @{Locale=Onboard Administrator; Bay=2; TempStatus=OK; Temp=36C/ 96F; Caution=75C; Critical=80C}, @{Locale=Blade Bay; Bay=4; TempStatus=N/A; Temp=18C/ 64F; Caution=62C; Critical=66C}...} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAEnclosureTemp IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK EnclosureTemp : {@{Locale=Enclosure; Bay=; TempStatus=OK; Temp=41C/105F; Caution=75C; Critical=80C}, @{Locale=Onboard Administrator; Bay=2; TempStatus=OK; Temp=41C/105F; Caution=75C; Critical=80C}, @{Locale=Blade Bay; Bay=5; TempStatus=N/A; Temp=0C/ 32F; Caution=45C; Critical=60C}, @{Locale=Interconnect Module; Bay=1; TempStatus=OK; Temp=; Caution=; Critical=}...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosureTemp : {@{Locale=Enclosure; Bay=; TempStatus=N/A; Temp=19C/ 66F; Caution=; Critical=}, @{Locale=Onboard Administrator; Bay=1; TempStatus=OK; Temp=36C/ 96F; Caution=75C; Critical=80C}, @{Locale=Onboard Administrator; Bay=2; TempStatus=OK; Temp=36C/ 96F; Caution=75C; Critical=80C}, @{Locale=Blade Bay; Bay=4; TempStatus=N/A; Temp=19C/ 66F; Caution=62C; Critical=66C}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAFIPSMode</command:name> <maml:description> <maml:para>Gets the FIPS mode setting.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAFIPSMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAFIPSMode cmdlet gets the FIPS mode setting. In ON mode, Onboard Administrator is in a FIPS 140-2-compliant mode. This includes the use of approved algorithms including AES, 3DES, SHA, and other security restrictions. In DEBUG mode, Onboard Administrator is in a similar state as ON but with option for HP debug support.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet. The cmdlet is not available on OA 3.x</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAFIPSMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAFIPSMode requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Get-HPEOAFIPSMode -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Mode : OFF IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Mode : OFF </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Get-HPEOAFIPSMode IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Mode : OFF IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Mode : OFF </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAFRU</command:name> <maml:description> <maml:para>Gets information on all field replaceable units within the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAFRU</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAFRU cmdlet gets information on all field replaceable units within the enclosure. Information provided in this section can quickly aid the administrator in contacting HP Customer Service for troubleshooting, repair, and ordering replacements. You must have access to the specific bay. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAFRU</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAFRU requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAFRU -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Enclosure : @{Model=BladeSystem c3000 Enclosure; Manufacturer=HP; SerialNumber=USE924MVA1; PartNumber=437506-B21} EnclosureMidplane : @{Manufacturer=HP; SparePartNumber=441829-001} OnboardAdministrator : {@{Model=c3000 Tray with embedded DDR2 Onboard Administrator; Manufacturer=HP; SerialNumber=PAMMT0C9VXA09J; PartNumber=488099-B21; SparePartNumber=486823-001; FirmwareVersion=3.11; HwVersion=C0; Bay=2}} Blade : {@{Model=HP StorageWorks SB40c; Manufacturer=HP; SerialNumber=USP7120KDE; PartNumber=411243-B21; SparePartNumber=430798-001; Bay=5}, @{Model=ProLiant BL460c Gen8; Manufacturer=HP; SerialNumber=6CU4100JM1; PartNumber=641016-B21; SparePartNumber=738239-001; Bay=7}} Interconnect : {@{Model=HP 1Gb Ethernet Pass-Thru Module for c-Class BladeSystem; Manufacturer=HP; SerialNumber=TWT917V1NH; PartNumber=406740-B21; SparePartNumber=419329-001; Bay=1}, @{Model=GbE2c Ethernet Blade Switch; Manufacturer=HP; SerialNumber=MY37250M7E; PartNumber=410917-B21; SparePartNumber=414037-001; Bay=2}, @{Model=HP 8/24c SAN Switch Pwr Pk+ BladeSystem c-Class; Manufacturer=BROCADE; SerialNumber=; PartNumber=AJ822A; SparePartNumber=489866-001; Bay=3}, @{Model=HP 8/24c SAN Switch Pwr Pk+ BladeSystem c-Class; Manufacturer=BROCADE; SerialNumber=; PartNumber=AJ822A; SparePartNumber=489866-001; Bay=4}} Fan : {@{Model=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; FanNumber=1}, @{Model=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; FanNumber=2}, @{Model=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; FanNumber=3}, @{Model=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; FanNumber=4}...} PowerSupply : {@{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DX902X; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=1}, @{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DY001J; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=2}, @{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DXB224; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=4}, @{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DY001O; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=5}} InsightDisplay : @{Model=BladeSystem c3000 Insight Display; Manufacturer=HP; SparePartNumber=519312-001; FirmwareVersion=2.4.3} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Enclosure : @{Model=BladeSystem c3000 Enclosure; Manufacturer=HP; SerialNumber=USE924MVBT; PartNumber=0123456789} EnclosureMidplane : @{Manufacturer=HP; SparePartNumber=441829-001} OnboardAdministrator : {@{Model=c3000 Tray with embedded DDR2 Onboard Administrator; Manufacturer=HP; SerialNumber=PAMMT0A9VWY01N; PartNumber=488099-B21; SparePartNumber=486823-001; FirmwareVersion=3.30; HwVersion=A0; Bay=2}} Blade : {@{Model=Integrity BL860c i2; Manufacturer=hp; SerialNumber=US23456789; PartNumber=AD399A; SparePartNumber=AD399-60001; Mezz=System.Management.Automation.PSObject[]; Bay=1}, @{Model=Integrity BL860c i2; Manufacturer=hp; SerialNumber=USE951W9J8; PartNumber=AD399A; SparePartNumber=AD399-60001; Mezz=System.Management.Automation.PSObject[]; Bay=2}, @{Model=Integrity BL860c i2; Manufacturer=hp; SerialNumber=US23456789; PartNumber=AD399A; SparePartNumber=AD399-60001; Mezz=System.Management.Automation.PSObject[]; Bay=3}, @{Model=ProLiant BL620c G7; Manufacturer=HP; SerialNumber=6CU4100JM4; PartNumber=643786-B21; SparePartNumber=708070-001; Mezz=System.Management.Automation.PSObject[]; Bay=4}} Interconnect : {@{Model=HP 1/10Gb VC-Enet Module; Manufacturer=HP; SerialNumber=TW271200C0; PartNumber=399593-B22; SparePartNumber=399725-001; Bay=1}, @{Model=HP 1/10Gb VC-Enet Module; Manufacturer=HP; SerialNumber=TW2702000D; PartNumber=399593-B22; SparePartNumber=399725-001; Bay=2}} Fan : {@{Model=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; FanNumber=1}, @{Model=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; FanNumber=2}, @{Model=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; FanNumber=3}, @{Model=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; FanNumber=4}...} PowerSupply : {@{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DY000T; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=1}, @{Model=HP PROLIANT SERVER PS; SerialNumber=531290A4DUY112; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=2}, @{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DY002Q; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=4}, @{Model=HP PROLIANT SERVER PS; SerialNumber=531290A4DUY0LW; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=5}} InsightDisplay : @{Model=BladeSystem c3000 Insight Display; Manufacturer=HP; SparePartNumber=519312-001; FirmwareVersion=2.4.3} KVMOptionModule : @{Model=ProLiant BL c3000 KVM Board; Manufacturer=HP; SerialNumber=P30650BTM5W011; PartNumber=433569-001; SparePartNumber=441834-001}</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAFRU IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Enclosure : @{Model=BladeSystem c3000 Enclosure; Manufacturer=HP; SerialNumber=USE924MVA1; PartNumber=437506-B21} EnclosureMidplane : @{Manufacturer=HP; SparePartNumber=441829-001} OnboardAdministrator : {@{Model=c3000 Tray with embedded DDR2 Onboard Administrator; Manufacturer=HP; SerialNumber=PAMMT0C9VXA09J; PartNumber=488099-B21; SparePartNumber=486823-001; FirmwareVersion=3.11; HwVersion=C0; Bay=2}} Blade : {@{Model=HP StorageWorks SB40c; Manufacturer=HP; SerialNumber=USP7120KDE; PartNumber=411243-B21; SparePartNumber=430798-001; Bay=5}, @{Model=ProLiant BL460c Gen8; Manufacturer=HP; SerialNumber=6CU4100JM1; PartNumber=641016-B21; SparePartNumber=738239-001; Bay=7}} Interconnect : {@{Model=HP 1Gb Ethernet Pass-Thru Module for c-Class BladeSystem; Manufacturer=HP; SerialNumber=TWT917V1NH; PartNumber=406740-B21; SparePartNumber=419329-001; Bay=1}, @{Model=GbE2c Ethernet Blade Switch; Manufacturer=HP; SerialNumber=MY37250M7E; PartNumber=410917-B21; SparePartNumber=414037-001; Bay=2}, @{Model=HP 8/24c SAN Switch Pwr Pk+ BladeSystem c-Class; Manufacturer=BROCADE; SerialNumber=; PartNumber=AJ822A; SparePartNumber=489866-001; Bay=3}, @{Model=HP 8/24c SAN Switch Pwr Pk+ BladeSystem c-Class; Manufacturer=BROCADE; SerialNumber=; PartNumber=AJ822A; SparePartNumber=489866-001; Bay=4}} Fan : {@{Model=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; FanNumber=1}, @{Model=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; FanNumber=2}, @{Model=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; FanNumber=3}, @{Model=Active Cool 100 Fan; PartNumber=507082-B21; SparePartNumber=507521-001; FanNumber=4}...} PowerSupply : {@{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DX902X; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=1}, @{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DY001J; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=2}, @{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DXB224; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=4}, @{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DY001O; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=5}} InsightDisplay : @{Model=BladeSystem c3000 Insight Display; Manufacturer=HP; SparePartNumber=519312-001; FirmwareVersion=2.4.3} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Enclosure : @{Model=BladeSystem c3000 Enclosure; Manufacturer=HP; SerialNumber=USE924MVBT; PartNumber=0123456789} EnclosureMidplane : @{Manufacturer=HP; SparePartNumber=441829-001} OnboardAdministrator : {@{Model=c3000 Tray with embedded DDR2 Onboard Administrator; Manufacturer=HP; SerialNumber=PAMMT0A9VWY01N; PartNumber=488099-B21; SparePartNumber=486823-001; FirmwareVersion=3.30; HwVersion=A0; Bay=2}} Blade : {@{Model=Integrity BL860c i2; Manufacturer=hp; SerialNumber=US23456789; PartNumber=AD399A; SparePartNumber=AD399-60001; Mezz=System.Management.Automation.PSObject[]; Bay=1}, @{Model=Integrity BL860c i2; Manufacturer=hp; SerialNumber=USE951W9J8; PartNumber=AD399A; SparePartNumber=AD399-60001; Mezz=System.Management.Automation.PSObject[]; Bay=2}, @{Model=Integrity BL860c i2; Manufacturer=hp; SerialNumber=US23456789; PartNumber=AD399A; SparePartNumber=AD399-60001; Mezz=System.Management.Automation.PSObject[]; Bay=3}, @{Model=ProLiant BL620c G7; Manufacturer=HP; SerialNumber=6CU4100JM4; PartNumber=643786-B21; SparePartNumber=708070-001; Mezz=System.Management.Automation.PSObject[]; Bay=4}} Interconnect : {@{Model=HP 1/10Gb VC-Enet Module; Manufacturer=HP; SerialNumber=TW271200C0; PartNumber=399593-B22; SparePartNumber=399725-001; Bay=1}, @{Model=HP 1/10Gb VC-Enet Module; Manufacturer=HP; SerialNumber=TW2702000D; PartNumber=399593-B22; SparePartNumber=399725-001; Bay=2}} Fan : {@{Model=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; FanNumber=1}, @{Model=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; FanNumber=2}, @{Model=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; FanNumber=3}, @{Model=Active Cool 200 Fan; PartNumber=412140-B21; SparePartNumber=413996-001; FanNumber=4}...} PowerSupply : {@{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DY000T; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=1}, @{Model=HP PROLIANT SERVER PS; SerialNumber=531290A4DUY112; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=2}, @{Model=HP PROLIANT SERVER PS; SerialNumber=5AMJQ0D4DY002Q; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=4}, @{Model=HP PROLIANT SERVER PS; SerialNumber=531290A4DUY0LW; PartNumber=437572-B21; SparePartNumber=441830-001; PowerSupplyNumber=5}} InsightDisplay : @{Model=BladeSystem c3000 Insight Display; Manufacturer=HP; SparePartNumber=519312-001; FirmwareVersion=2.4.3} KVMOptionModule : @{Model=ProLiant BL c3000 KVM Board; Manufacturer=HP; SerialNumber=P30650BTM5W011; PartNumber=433569-001; SparePartNumber=441834-001}</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAFWLogServer</command:name> <maml:description> <maml:para>Gets the firmware log for the selected server or range of servers.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAFWLogServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAFWLogServer cmdlet gets the firmware log for the selected server or range of servers. You must have access to the specified bay number. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAFWLogServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the servers for which the firmware logs are to be retrieved. Bay number(s) can be specified as All|<Bay number>|<bay number>[,|-<bay number>].</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAFWLogServer requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAFWLogServer -Connection $connection -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Log : {@{BayNumber=1; FirmwareLog=There is no firmware log for this device.}, @{BayNumber=4; FirmwareLog=System.Management.Automation.PSObject[]}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : There are no firmware logs to display. </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with bay.</maml: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-HPEOAFWLogServer -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Log : {@{BayNumber=1; FirmwareLog=There is no firmware log for this device.}, @{BayNumber=2; FirmwareLog=There is no firmware log for this device.}, @{BayNumber=3; FirmwareLog=There is no device present.}, @{BayNumber=4; FirmwareLog=System.Management.Automation.PSObject[]}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : There are no firmware logs to display. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, the default value All is used. </maml: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:\> $connection | Get-HPEOAFWLogServer IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Log : {@{BayNumber=1; FirmwareLog=There is no firmware log for this device.}, @{BayNumber=2; FirmwareLog=There is no firmware log for this device.}, @{BayNumber=3; FirmwareLog=There is no device present.}, @{BayNumber=4; FirmwareLog=System.Management.Automation.PSObject[]}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : There are no firmware logs to display. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAFWLogSession</command:name> <maml:description> <maml:para>Gets the firmware log session for the selected server or range of servers.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAFWLogSession</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAFWLogSession cmdlet gets the firmware log session for the selected server or range of servers. You must have access to the specified bay number. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAFWLogSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the servers for which the firmware log session details are displayed. All or a range of Bays can be specified for retrieving the details. The bay number(s) can be specified as All|<Bay number>|<bay number>[,|-<bay number>]. The default value All is used if bay is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAFWLogSession requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAFWLogSession -Connection $connection -Bay $bay IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.241.254 northwind.company.net OK There are no firmware session logs to dis... 192.168.242.64 southwind.company.net OK There are no firmware session logs to dis... </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with bay.</maml: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-HPEOAFWLogSession -Connection $connection IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.241.254 northwind.company.net OK There are no firmware session logs to dis... 192.168.242.64 southwind.company.net OK There are no firmware session logs to dis... </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, the default value All is used.</maml: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:\> $connection | Get-HPEOAFWLogSession IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.241.254 northwind.company.net OK There are no firmware session logs to dis... 192.168.242.64 southwind.company.net OK There are no firmware session logs to dis... </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAFWManagement</command:name> <maml:description> <maml:para>Gets enclosure firmware management configuration settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAFWManagement</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAFWManagement cmdlet gets enclosure firmware management configuration settings. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAFWManagement</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAFWManagement requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAFWManagement -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Enclosure : abc FirmwareManagement : Enabled ForceDowngrade : Disabled FirmwareISOURL : http://192.168.243.31/FW930.iso FirmwarePowerPolicy : OFF FirmwarePolicy : Manual Only FirmwareDate : Not Set BaysToInclude : @{ServerBays=1 1A 1B 2 2A 2B 3 3A 3B 4 4A 4B 5 5A 5B 6 6A 6B 7 7A 7B 8 8A 8B} FirmwareISOInformation : @{ISOURLStatus=Valid URL; Version=9.30; Name=HP Smart Update Firmware DVD; ISOOAVersion=3.30} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Enclosure : PoseidonC7000_MidC FirmwareManagement : Disabled ForceDowngrade : Enabled FirmwareISOURL : Not Set FirmwarePowerPolicy : POWEROFF FirmwarePolicy : Manual Only FirmwareDate : Not Set BaysToInclude : @{ServerBays=1 1A 1B 2 2A 2B 3 3A 3B 4 4A 4B 5 5A 5B 6 6A 6B 7 7A 7B 8 8A 8B 9 9A 9B 10 10A 10B 11 11A 11B 12 12A 12B 13 13A 13B 14 14A 14B 15 15A 15B 16 16A 16B} FirmwareISOInformation : @{ISOURLStatus=N/A} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAFWManagement IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Enclosure : abc FirmwareManagement : Enabled ForceDowngrade : Disabled FirmwareISOURL : http://192.168.243.31/FW930.iso FirmwarePowerPolicy : OFF FirmwarePolicy : Manual Only FirmwareDate : Not Set BaysToInclude : @{ServerBays=1 1A 1B 2 2A 2B 3 3A 3B 4 4A 4B 5 5A 5B 6 6A 6B 7 7A 7B 8 8A 8B} FirmwareISOInformation : @{ISOURLStatus=Valid URL; Version=9.30; Name=HP Smart Update Firmware DVD; ISOOAVersion=3.30} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Enclosure : PoseidonC7000_MidC FirmwareManagement : Disabled ForceDowngrade : Enabled FirmwareISOURL : Not Set FirmwarePowerPolicy : POWEROFF FirmwarePolicy : Manual Only FirmwareDate : Not Set BaysToInclude : @{ServerBays=1 1A 1B 2 2A 2B 3 3A 3B 4 4A 4B 5 5A 5B 6 6A 6B 7 7A 7B 8 8A 8B 9 9A 9B 10 10A 10B 11 11A 11B 12 12A 12B 13 13A 13B 14 14A 14B 15 15A 15B 16 16A 16B} FirmwareISOInformation : @{ISOURLStatus=N/A} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAFWManagementLog</command:name> <maml:description> <maml:para>Gets the enclosure firmware management log.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAFWManagementLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAFWManagementLog cmdlet gets the enclosure firmware management log. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAFWManagementLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAFWManagementLog requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAFWManagementLog -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Log : {@{Time=Nov 14 17:25:00; Message=Enclosure Firmware Management URL set to http//c/d.iso.}, @{Time=Nov 14 17:25:00; Message=Force downgrade option disabled.}, @{Time=Nov 14 17:25:01; Message=Enclosure Firmware Management policy set to auto update.}, @{Time=Nov 14 17:25:01; Message=Enclosure Firmware Management power off policy changed to FORCE.}...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Log : {@{Time=Oct 10 02:00:51; Message=Enclosure Firmware Management started.}, @{Time=Oct 10 23:01:43; Message=Enclosure Firmware Management terminated.}, @{Time=Oct 10 23:02:28; Message=Enclosure Firmware Management started.}, @{Time=Oct 15 23:46:03; Message=Enclosure Firmware Management started.}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection | Get-HPEOAFWManagementLog IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Log : {@{Time=Nov 14 17:25:00; Message=Enclosure Firmware Management URL set to http//c/d.iso.}, @{Time=Nov 14 17:25:00; Message=Force downgrade option disabled.}, @{Time=Nov 14 17:25:01; Message=Enclosure Firmware Management policy set to auto update.}, @{Time=Nov 14 17:25:01; Message=Enclosure Firmware Management power off policy changed to FORCE.}...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Log : {@{Time=Oct 10 02:00:51; Message=Enclosure Firmware Management started.}, @{Time=Oct 10 23:01:43; Message=Enclosure Firmware Management terminated.}, @{Time=Oct 10 23:02:28; Message=Enclosure Firmware Management started.}, @{Time=Oct 15 23:46:03; Message=Enclosure Firmware Management started.}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAFWSummary</command:name> <maml:description> <maml:para>Gets a summary of enclosure firmware components.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAFWSummary</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAFWSummary cmdlet gets a summary of enclosure firmware components. An exclamation mark (!) indicates firmware mismatch or missing firmware information. If the CSV keyword is used, the summary will be output in CSV format.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAFWSummary</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAFWSummary requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAFWSummary -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK OnboardAdministratorFirmwareInformation : {@{Bay=1; Model=OA Absent; FirmwareVersion=}, @{Bay=2; Model=c3000 Tray with embedded DDR2 Onboard Administrator; FirmwareVersion=4.22}} EnclosureComponentFirmwareInformation : {@{Device=TRAY; Name=c3000 Tray with embedded DDR2 Onboard Adminis; Location=; Version=2.10; NewVersion=2.10}, @{Device=LCD; Name=BladeSystem c3000 Insight Display; Location=; Version=2.4.3; NewVersion=2.4.3}, @{Device=FAN; Name=Active Cool 200 Fan; Location=1; Version=2.7.4; NewVersion=2.7.4}, @{Device=FAN; Name=Active Cool 200 Fan; Location=2; Version=2.7.4; NewVersion=2.7.4}...} DeviceFirmwareInformation : {@{Bay=1; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=3; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=4; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}} InterconnectFirmwareInformation : {@{Bay=1; DeviceModel=HP 1/10Gb VC-Enet Module; FirmwareVersion=2.32}, @{Bay=2; DeviceModel=HP 1/10Gb VC-Enet Module; FirmwareVersion=2.32}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK OnboardAdministratorFirmwareInformation : {@{Bay=1; Model=BladeSystem c7000 DDR2 Onboard Administrator with KVM; FirmwareVersion=4.22}, @{Bay=2; Model=BladeSystem c7000 Onboard Administrator; FirmwareVersion=4.22}} EnclosureComponentFirmwareInformation : {@{Device=TRAY; Name=BladeSystem c7000 Onboard Administrator Tray; Location=; Version=1.7; NewVersion=1.7}, @{Device=LCD; Name=BladeSystem c7000 Insight Display; Location=; Version=2.2.2; NewVersion=2.2.2}, @{Device=BLADE; Name=D2200sb Storage Blade; Location=1; Version=2.30; NewVersion=2.30}, @{Device=FAN; Name=Active Cool 200 Fan; Location=1; Version=2.7.4; NewVersion=2.7.4}...} DeviceFirmwareInformation : {@{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=4; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=7; Discovered=Tue 2014-06-03 22:26:12; DeviceFWDetail=System.Management.Automation.PSObject[]}} InterconnectFirmwareInformation : {@{Bay=1; DeviceModel=HP 1/10Gb-F VC-Enet Module; FirmwareVersion=2.32}, @{Bay=2; DeviceModel=HP 1/10Gb-F VC-Enet Module; FirmwareVersion=2.32}, @{Bay=3; DeviceModel=HP 4Gb VC-FC Module; FirmwareVersion=1.40}, @{Bay=4; DeviceModel=HP 4Gb VC-FC Module; FirmwareVersion=1.40}...} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAFWSummary IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK OnboardAdministratorFirmwareInformation : {@{Bay=1; Model=OA Absent; FirmwareVersion=}, @{Bay=2; Model=c3000 Tray with embedded DDR2 Onboard Administrator; FirmwareVersion=4.22}} EnclosureComponentFirmwareInformation : {@{Device=TRAY; Name=c3000 Tray with embedded DDR2 Onboard Adminis; Location=; Version=2.10; NewVersion=2.10}, @{Device=LCD; Name=BladeSystem c3000 Insight Display; Location=; Version=2.4.3; NewVersion=2.4.3}, @{Device=FAN; Name=Active Cool 200 Fan; Location=1; Version=2.7.4; NewVersion=2.7.4}, @{Device=FAN; Name=Active Cool 200 Fan; Location=2; Version=2.7.4; NewVersion=2.7.4}...} DeviceFirmwareInformation : {@{Bay=1; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=3; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=4; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}} InterconnectFirmwareInformation : {@{Bay=1; DeviceModel=HP 1/10Gb VC-Enet Module; FirmwareVersion=2.32}, @{Bay=2; DeviceModel=HP 1/10Gb VC-Enet Module; FirmwareVersion=2.32}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK OnboardAdministratorFirmwareInformation : {@{Bay=1; Model=BladeSystem c7000 DDR2 Onboard Administrator with KVM; FirmwareVersion=4.22}, @{Bay=2; Model=BladeSystem c7000 Onboard Administrator; FirmwareVersion=4.22}} EnclosureComponentFirmwareInformation : {@{Device=TRAY; Name=BladeSystem c7000 Onboard Administrator Tray; Location=; Version=1.7; NewVersion=1.7}, @{Device=LCD; Name=BladeSystem c7000 Insight Display; Location=; Version=2.2.2; NewVersion=2.2.2}, @{Device=BLADE; Name=D2200sb Storage Blade; Location=1; Version=2.30; NewVersion=2.30}, @{Device=FAN; Name=Active Cool 200 Fan; Location=1; Version=2.7.4; NewVersion=2.7.4}...} DeviceFirmwareInformation : {@{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=4; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=7; Discovered=Tue 2014-06-03 22:26:12; DeviceFWDetail=System.Management.Automation.PSObject[]}} InterconnectFirmwareInformation : {@{Bay=1; DeviceModel=HP 1/10Gb-F VC-Enet Module; FirmwareVersion=2.32}, @{Bay=2; DeviceModel=HP 1/10Gb-F VC-Enet Module; FirmwareVersion=2.32}, @{Bay=3; DeviceModel=HP 4Gb VC-FC Module; FirmwareVersion=1.40}, @{Bay=4; DeviceModel=HP 4Gb VC-FC Module; FirmwareVersion=1.40}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAHealth</command:name> <maml:description> <maml:para>Gets current health of all components in the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAHealth</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAHealth cmdlet gets current health of all components in the enclosure. If a component is degraded or failed, a cause and corrective action are provided. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAHealth</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAHealth requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAHealth -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosureHealth : @{Enclosure=Degraded; PowerSubsystem=OK; CoolingSubsystem=OK} BladeHealth : {@{Bay=1; Status=Other; Problem=VCM Configured; CorrectiveAction=When the Virtual Connect Manager is present the server needs a configuration profile to be able to use the VCM module.}, @{Bay=2; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=3; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=4; Status=Other; Problem=VCM Configured; CorrectiveAction=When the Virtual Connect Manager is present the server needs a configuration profile to be able to use the VCM module.}...} InterconnectHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} PowerSupplyHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} FanHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} OnboardAdministratorHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=Error; Problem=Firmware Mismatch; CorrectiveAction=The firmware on both active and standby OA must match in order to provide redundancy. Update the OA firmware.}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK EnclosureHealth : @{Enclosure=Degraded; PowerSubsystem=Degraded; CoolingSubsystem=OK} BladeHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=Error; Problem=I/O Configuration; CorrectiveAction=Configuration error. Check that interconnect type matches server port type. Move interconnects or mezz cards to eliminate type mismatch.}...} InterconnectHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=Error; Problem=I/O Configuration; CorrectiveAction=Configuration error. Check that interconnect type matches server port type. Move interconnects or mezz cards to eliminate type mismatch.}, @{Bay=3; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=4; Status=Absent; Problem=; CorrectiveAction=}} PowerSupplyHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} FanHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} OnboardAdministratorHealth : {@{Bay=1; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAHealth IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosureHealth : @{Enclosure=Degraded; PowerSubsystem=OK; CoolingSubsystem=OK} BladeHealth : {@{Bay=1; Status=Other; Problem=VCM Configured; CorrectiveAction=When the Virtual Connect Manager is present the server needs a configuration profile to be able to use the VCM module.}, @{Bay=2; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=3; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=4; Status=Other; Problem=VCM Configured; CorrectiveAction=When the Virtual Connect Manager is present the server needs a configuration profile to be able to use the VCM module.}...} InterconnectHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} PowerSupplyHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} FanHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} OnboardAdministratorHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=Error; Problem=Firmware Mismatch; CorrectiveAction=The firmware on both active and standby OA must match in order to provide redundancy. Update the OA firmware.}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK EnclosureHealth : @{Enclosure=Degraded; PowerSubsystem=Degraded; CoolingSubsystem=OK} BladeHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=Error; Problem=I/O Configuration; CorrectiveAction=Configuration error. Check that interconnect type matches server port type. Move interconnects or mezz cards to eliminate type mismatch.}...} InterconnectHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=Error; Problem=I/O Configuration; CorrectiveAction=Configuration error. Check that interconnect type matches server port type. Move interconnects or mezz cards to eliminate type mismatch.}, @{Bay=3; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=4; Status=Absent; Problem=; CorrectiveAction=}} PowerSupplyHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} FanHealth : {@{Bay=1; Status=OK; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}, @{Bay=3; Status=OK; Problem=; CorrectiveAction=}, @{Bay=4; Status=OK; Problem=; CorrectiveAction=}...} OnboardAdministratorHealth : {@{Bay=1; Status=Absent; Problem=; CorrectiveAction=}, @{Bay=2; Status=OK; Problem=; CorrectiveAction=}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAHPSIMInfo</command:name> <maml:description> <maml:para>Gets the current HP SIM SSO configuration for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAHPSIMInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAHPSIMInfo cmdlet gets the current HP SIM SSO configuration for the Onboard Administrator. The data includes the current HP SIM SSO Trust Mode (see Set-HPEOAHPSIMTrustMode) and a list of names that the Onboard Administrator is configured to trust using a trust certificate. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAHPSIMInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAHPSIMInfo requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAHPSIMInfo -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK TrustedServerCertificate : {@{CommonName=OA-002264345175; Certificate=-----BEGIN CERTIFICATE----- MIICHzCCAYgCCQCc00bW5VoGGjANBgkqhkiG9w0BAQQFADBUMRgwFgYDVQQKEw9I ZXdsZXR0LVBhY2thcmQxHjAcBgNVBAsTFU9uYm9hcmQgQWRtaW5pc3RyYXRvcjEY MBYGA1UEAxMPT0EtMDAyMjY0MzQ1MTc1MB4XDTA5MTIxNjExNTkxNFoXDTE5MTIx NDExNTkxNFowVDEYMBYGA1UEChMPSGV3bGV0dC1QYWNrYXJkMR4wHAYDVQQLExVP bmJvYXJkIEFkbWluaXN0cmF0b3IxGDAWBgNVBAMTD09BLTAwMjI2NDM0NTE3NTCB nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAogAsUaI7gcsFwfT3LvALb9MdYbGk /ZeJGcpgv4BAbG1BFbf9IYzeoCgLWyTZ0EMuVTB54IIdDS7G01iU8MJPLK/Yk0Cf Jh0SxMGWHH0uTdm4DggjZuonhjntPi7kquElI2gDuh4TPxPqa/v53ojDNlD5oaBW jKpjtQaUmXzWPCMCAwEAATANBgkqhkiG9w0BAQQFAAOBgQAhzJ7/cLAcIWkVmaMl 7FpAyOgnijaq240QPurM2GZVTojDPw0yJwtCTlth9xsFxf3P4w9r4WfBbcYkkg3N EBEYHrTsxD/9sC1f1oqNjxL/Jtw6y9CrcpfTMkfPN+p3Jgxr/MJ+IP4i1NH8I6iV 2IjIJF74pDop4Z4MqCQFuJbu9g== -----END CERTIFICATE-----; TrustedServerCertificateNumber=1}} HPSIMTrustMode : Disabled IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK TrustedServerCertificate : {@{CommonName=vcrm-w2k8-ftp; Certificate=-----BEGIN CERTIFICATE----- MIICyjCCAjOgAwIBAgIJUqQ5mJpE5lUzMA0GCSqGSIb3DQEBBQUAMIGmMQswCQYD VQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRv MSAwHgYDVQQKExdIZXdsZXR0LVBhY2thcmQgQ29tcGFueTE0MDIGA1UECxMrSGV3 bGV0dC1QYWNrYXJkIE5ldHdvcmsgTWFuYWdlbWVudCBTb2Z0d2FyZTEWMBQGA1UE AxMNdmNybS13Mms4LWZ0cDAeFw0xMDEwMTUwNDU1NTdaFw0yMDEwMTUwNDU1NTda MIGmMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJ UGFsbyBBbHRvMSAwHgYDVQQKExdIZXdsZXR0LVBhY2thcmQgQ29tcGFueTE0MDIG A1UECxMrSGV3bGV0dC1QYWNrYXJkIE5ldHdvcmsgTWFuYWdlbWVudCBTb2Z0d2Fy ZTEWMBQGA1UEAxMNdmNybS13Mms4LWZ0cDCBnzANBgkqhkiG9w0BAQEFAAOBjQAw gYkCgYEAjYE4ggEG7gySiTZn9zo8Kth6OjcMnARQKwziheq17bLwmO64V3+ucyLN uZzBeLzcXlY/e1zydZFOHHXsgPii02lTz8fLqipkHOSO3opg6n9IA9XQ2dalrAUw u6LZtB6tymW84OHCeL6voC9dZ3oSIHQLfgSneQA3/733UkBjMTUCAwEAATANBgkq hkiG9w0BAQUFAAOBgQAaSbgF22aihCjGL5eDjvH73mMxSWrX6H3yUh90kl3ECUzd UozKCRR5u8pD/SAx7PjGlzVBKPiyzyE7K9GxWSGv/+r9Pprgp9li22e3ZRPkK/dg XzXlcYFZiTBId58N+NilVCD0xZcSgAwjagu9ysEbtMvNfLzHm/XU1V3VSM4YxQ== -----END CERTIFICATE-----; TrustedServerCertificateNumber=1}, @{ CommonName=GlobalSign Root CA; Certificate=-----BEGIN CERTIFICATE----- MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkG A1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jv b3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAw MDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNVBAYTAkJFMRkwFwYDVQQKExBHbG9i YWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYDVQQDExJHbG9iYWxT aWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDaDuaZ jc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavp xy0Sy6scTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp 1Wrjsok6Vjk4bwY8iGlbKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdG snUOhugZitVtbNV4FpWi6cgKOOvyJBNPc1STE4U6G7weNLWLBYy5d4ux2x8gkasJ U26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrXgzT/LCrBbBlDSgeF59N8 9iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8E BTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0B AQUFAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOz yj1hTdNGCbM+w6DjY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE 38NflNUVyRRBnMRddWQVDf9VMOyGj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymP AbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhHhm4qxFYxldBniYUr+WymXUad DKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveCX4XSQRjbgbME HMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A== -----END CERTIFICATE-----; TrustedServerCertificateNumber=2}} HPSIMTrustMode : Disabled </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAHPSIMInfo IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK TrustedServerCertificate : {@{CommonName=OA-002264345175; Certificate=-----BEGIN CERTIFICATE----- MIICHzCCAYgCCQCc00bW5VoGGjANBgkqhkiG9w0BAQQFADBUMRgwFgYDVQQKEw9I ZXdsZXR0LVBhY2thcmQxHjAcBgNVBAsTFU9uYm9hcmQgQWRtaW5pc3RyYXRvcjEY MBYGA1UEAxMPT0EtMDAyMjY0MzQ1MTc1MB4XDTA5MTIxNjExNTkxNFoXDTE5MTIx NDExNTkxNFowVDEYMBYGA1UEChMPSGV3bGV0dC1QYWNrYXJkMR4wHAYDVQQLExVP bmJvYXJkIEFkbWluaXN0cmF0b3IxGDAWBgNVBAMTD09BLTAwMjI2NDM0NTE3NTCB nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAogAsUaI7gcsFwfT3LvALb9MdYbGk /ZeJGcpgv4BAbG1BFbf9IYzeoCgLWyTZ0EMuVTB54IIdDS7G01iU8MJPLK/Yk0Cf Jh0SxMGWHH0uTdm4DggjZuonhjntPi7kquElI2gDuh4TPxPqa/v53ojDNlD5oaBW jKpjtQaUmXzWPCMCAwEAATANBgkqhkiG9w0BAQQFAAOBgQAhzJ7/cLAcIWkVmaMl 7FpAyOgnijaq240QPurM2GZVTojDPw0yJwtCTlth9xsFxf3P4w9r4WfBbcYkkg3N EBEYHrTsxD/9sC1f1oqNjxL/Jtw6y9CrcpfTMkfPN+p3Jgxr/MJ+IP4i1NH8I6iV 2IjIJF74pDop4Z4MqCQFuJbu9g== -----END CERTIFICATE-----; TrustedServerCertificateNumber=1}} HPSIMTrustMode : Disabled IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK TrustedServerCertificate : {@{CommonName=vcrm-w2k8-ftp; Certificate=-----BEGIN CERTIFICATE----- MIICyjCCAjOgAwIBAgIJUqQ5mJpE5lUzMA0GCSqGSIb3DQEBBQUAMIGmMQswCQYD VQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRv MSAwHgYDVQQKExdIZXdsZXR0LVBhY2thcmQgQ29tcGFueTE0MDIGA1UECxMrSGV3 bGV0dC1QYWNrYXJkIE5ldHdvcmsgTWFuYWdlbWVudCBTb2Z0d2FyZTEWMBQGA1UE AxMNdmNybS13Mms4LWZ0cDAeFw0xMDEwMTUwNDU1NTdaFw0yMDEwMTUwNDU1NTda MIGmMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJ UGFsbyBBbHRvMSAwHgYDVQQKExdIZXdsZXR0LVBhY2thcmQgQ29tcGFueTE0MDIG A1UECxMrSGV3bGV0dC1QYWNrYXJkIE5ldHdvcmsgTWFuYWdlbWVudCBTb2Z0d2Fy ZTEWMBQGA1UEAxMNdmNybS13Mms4LWZ0cDCBnzANBgkqhkiG9w0BAQEFAAOBjQAw gYkCgYEAjYE4ggEG7gySiTZn9zo8Kth6OjcMnARQKwziheq17bLwmO64V3+ucyLN uZzBeLzcXlY/e1zydZFOHHXsgPii02lTz8fLqipkHOSO3opg6n9IA9XQ2dalrAUw u6LZtB6tymW84OHCeL6voC9dZ3oSIHQLfgSneQA3/733UkBjMTUCAwEAATANBgkq hkiG9w0BAQUFAAOBgQAaSbgF22aihCjGL5eDjvH73mMxSWrX6H3yUh90kl3ECUzd UozKCRR5u8pD/SAx7PjGlzVBKPiyzyE7K9GxWSGv/+r9Pprgp9li22e3ZRPkK/dg XzXlcYFZiTBId58N+NilVCD0xZcSgAwjagu9ysEbtMvNfLzHm/XU1V3VSM4YxQ== -----END CERTIFICATE-----; TrustedServerCertificateNumber=1}, @{ CommonName=GlobalSign Root CA; Certificate=-----BEGIN CERTIFICATE----- MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkG A1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jv b3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAw MDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNVBAYTAkJFMRkwFwYDVQQKExBHbG9i YWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYDVQQDExJHbG9iYWxT aWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDaDuaZ jc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavp xy0Sy6scTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp 1Wrjsok6Vjk4bwY8iGlbKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdG snUOhugZitVtbNV4FpWi6cgKOOvyJBNPc1STE4U6G7weNLWLBYy5d4ux2x8gkasJ U26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrXgzT/LCrBbBlDSgeF59N8 9iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8E BTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0B AQUFAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOz yj1hTdNGCbM+w6DjY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE 38NflNUVyRRBnMRddWQVDf9VMOyGj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymP AbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhHhm4qxFYxldBniYUr+WymXUad DKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveCX4XSQRjbgbME HMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A== -----END CERTIFICATE-----; TrustedServerCertificateNumber=2}} HPSIMTrustMode : Disabled </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAInfo</command:name> <maml:description> <maml:para>Gets information about the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAInfo cmdlet gets information about the Onboard Administrator. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the Onboard Administrator for which details are to be retrieved. If the Onboard Administrator is not specified, the command defaults to the Active Onboard Administrator. Value can be specified as All|<Bay number>|<bay number>[,|- <bay number>] | Active | StandBy </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Active</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAInfo requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAInfo -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{ProductName=c3000 Tray with embedded DDR2 Onboard Administrator; PartNumber=488099-B21; SparePartNo=486823-001; SerialNumber=PAMMT0C9VXA09J; UUID=18PAMMT0C9VXA09J; Manufacturer=HP; FirmwareVer=3.11 Aug 19 2010; HwBoardType=3; HwVersion=C0; Bay=2}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{ProductName=c3000 Tray with embedded DDR2 Onboard Administrator; PartNumber=488099-B21; SparePartNo=486823-001; SerialNumber=PAMMT0A9VWY01N; UUID=18PAMMT0A9VWY01N; Manufacturer=HP; FirmwareVer=3.30 Apr 19 2011; HwBoardType=3; HwVersion=A0; Bay=2}}</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter. The Bay parameter is not specified, the cmdlet shows the information about the Active Onboard Administrator by default.</maml: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:\> $connection | Get-HPEOAInfo -Bay $bay IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{ProductName=c3000 Tray with embedded DDR2 Onboard Administrator; PartNumber=488099-B21; SparePartNo=486823-001; SerialNumber=PAMMT0C9VXA09J; UUID=18PAMMT0C9VXA09J; Manufacturer=HP; FirmwareVer=3.11 Aug 19 2010; HwBoardType=3; HwVersion=C0; Bay=2}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{ProductName=c3000 Tray with embedded DDR2 Onboard Administrator; PartNumber=488099-B21; SparePartNo=486823-001; SerialNumber=PAMMT0A9VWY01N; UUID=18PAMMT0A9VWY01N; Manufacturer=HP; FirmwareVer=3.30 Apr 19 2011; HwBoardType=3; HwVersion=A0; Bay=2}}</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. The specified bay of the Onboard Administrator for which details are retrieved from the cmdlet.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAInterconnectInfo</command:name> <maml:description> <maml:para>Gets interconnect settings and information.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAInterconnectInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAInterconnectInfo cmdlet gets the following information: - Interconnect type - Manufacturer name - Product name - Product part number - Product version - Product serial number - Asset tag - VLAN ID </maml:para> <maml:para>You must have explicit access to a bay given by the Add-HPEOAUserBay command. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAInterconnectInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the Interconnects for which information is to be retrieved. The bay number(s) can be specified as All|<Bay number>|<bay number>[,|-<bay number>]. The default value All is used if bay is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAInterconnectInfo requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAInterconnectInfo -Connection $connection -Bay $bay IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectBay : {@{Type=Ethernet; ProductName=HP 1Gb Ethernet Pass-Thru Module for c-Class BladeSystem; Width=Single; URLToManagementInterface=; InBandIPv4Address=0.0.0.0; UserAssignedName=; PartNumber=406740-B21; SparePartNumber=419329-001; SerialNumber=TWT917V1NH; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Absent; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Absent; InternalSerialRouteToOA=Enabled; ExternalSerialPortInterface=Absent; ExternalEthernetInterface=Absent; Manufacturer=HP; Bay=1}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK InterconnectBay : {@{Type=Ethernet; ProductName=HP 1/10Gb VC-Enet Module; Width=Single; URLToManagementInterface=http://192.168.244.62/; InBandIPv4Address=192.168.244.62; UserAssignedName=; PartNumber=399593-B22; SparePartNumber=399725-001; SerialNumber=TW271200C0; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Present; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Present; InternalSerialRouteToOA=Enabled; SerialPortBaudRate=115200; ExternalSerialPortInterface=Absent; ExternalEthernetInterface=Absent; Manufacturer=HP; FirmwareVersion=2.32; Bay=1}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Bay.</maml: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-HPEOAInterconnectInfo -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectBay : {@{Type=Ethernet; ProductName=HP 1Gb Ethernet Pass-Thru Module for c-Class BladeSystem; Width=Single; URLToManagementInterface=; InBandIPv4Address=0.0.0.0; UserAssignedName=; PartNumber=406740-B21; SparePartNumber=419329-001; SerialNumber=TWT917V1NH; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Absent; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Absent; InternalSerialRouteToOA=Enabled; ExternalSerialPortInterface=Absent; ExternalEthernetInterface=Absent; Manufacturer=HP; Bay=1}, @{Type=Ethernet; ProductName=GbE2c Ethernet Blade Switch; Width=Single; URLToManagementInterface=http://192.168.246.113; InBandIPv4Address=192.168.246.113; UserAssignedName=; PartNumber=410917-B21; SparePartNumber=414037-001; SerialNumber=MY37250M7E; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Present; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Absent; InternalSerialRouteToOA=Disabled; ExternalSerialPortInterface=Present; ExternalEthernetInterface=Present; Manufacturer=HP; Bay=2}, @{Type=Fibre; ProductName=HP 8/24c SAN Switch Pwr Pk+ BladeSystem c-Class; Width=Single; URLToManagementInterface=http://192.168.246.242; InBandIPv4Address=192.168.246.242; UserAssignedName=swd77; PartNumber=AJ822A; SparePartNumber=489866-001; SerialNumber=; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Present; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Present; InternalSerialRouteToOA=Enabled; SerialPortBaudRate=9600; ExternalSerialPortInterface=Absent; ExternalEthernetInterface=Absent; Manufacturer=BROCADE; Bay=3}, @{Type=Fibre; ProductName=HP 8/24c SAN Switch Pwr Pk+ BladeSystem c-Class; Width=Single; URLToManagementInterface=http://192.168.247.254; InBandIPv4Address=192.168.247.254; UserAssignedName=swd77; PartNumber=AJ822A; SparePartNumber=489866-001; SerialNumber=; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Present; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Present; InternalSerialRouteToOA=Enabled; SerialPortBaudRate=9600; ExternalSerialPortInterface=Absent; ExternalEthernetInterface=Absent; Manufacturer=BROCADE; Bay=4}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK InterconnectBay : {@{Type=Ethernet; ProductName=HP 1/10Gb VC-Enet Module; Width=Single; URLToManagementInterface=http://192.168.244.62/; InBandIPv4Address=192.168.244.62; UserAssignedName=; PartNumber=399593-B22; SparePartNumber=399725-001; SerialNumber=TW271200C0; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Present; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Present; InternalSerialRouteToOA=Enabled; SerialPortBaudRate=115200; ExternalSerialPortInterface=Absent; ExternalEthernetInterface=Absent; Manufacturer=HP; FirmwareVersion=2.32; Bay=1}, @{Type=Ethernet; ProductName=HP 1/10Gb VC-Enet Module; Width=Single; URLToManagementInterface=http://192.168.246.94/; InBandIPv4Address=192.168.246.94; UserAssignedName=; PartNumber=399593-B22; SparePartNumber=399725-001; SerialNumber=TW2702000D; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Present; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Present; InternalSerialRouteToOA=Enabled; SerialPortBaudRate=115200; ExternalSerialPortInterface=Absent; ExternalEthernetInterface=Absent; Manufacturer=HP; FirmwareVersion=2.32; Bay=2}, @{Type=<absent>; Bay=3}, @{Type=<absent>; Bay=4}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Parameter Bay is not input, so the default value ALL is used, and the information of all the bays is displayed.</maml: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:\> $server | Get-HPEOAInterconnectInfo IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK InterconnectBay : {@{Type=Ethernet; ProductName=HP 1/10Gb VC-Enet Module; Width=Single; URLToManagementInterface=http://192.168.244.62/; InBandIPv4Address=192.168.244.62; UserAssignedName=; PartNumber=399593-B22; SparePartNumber=399725-001; SerialNumber=TW271200C0; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Present; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Present; InternalSerialRouteToOA=Enabled; SerialPortBaudRate=115200; ExternalSerialPortInterface=Absent; ExternalEthernetInterface=Absent; Manufacturer=HP; FirmwareVersion=2.32; Bay=1}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK InterconnectBay : {@{Type=Ethernet; ProductName=HP 1/10Gb-F VC-Enet Module; Width=Single; URLToManagementInterface=http://192.168.244.127/; InBandIPv4Address=192.168.244.127; UserAssignedName=; PartNumber=447047-B21; SparePartNumber=447103-001; SerialNumber=TW2737005C; TemperatureSensor=Present; JS2Connector=Absent; InternalEthernetInterfaceToOA=Present; InternalEthernetRouteToOA=Enabled; InternalSerialInterfaceToOA=Present; InternalSerialRouteToOA=Enabled; SerialPortBaudRate=115200; ExternalSerialPortInterface=Absent; ExternalEthernetInterface=Absent; Manufacturer=HP; FirmwareVersion=2.32; VLANID=1; Bay=1}}</dev:code> <dev:remarks> <maml:para>In this example connection and bay information in $server is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAInterconnectList</command:name> <maml:description> <maml:para>Gets the interconnect list.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAInterconnectList</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAInterconnectList cmdlet gets the interconnect list. You must have explicit access to a bay given by the Add-HPEOAUserBay command. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAInterconnectList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAInterconnectList requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAInterconnectList -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectList : {@{Bay=1; InterconnectType=Ethernet; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=0.0.0.0}, @{Bay=2; InterconnectType=Ethernet; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=192.168.246.113}, @{Bay=3; InterconnectType=Fibre Channel; Manufacturer=BROCADE; Power=On; Health=OK; UID=Off; ManagementIP=192.168.246.242}, @{Bay=4; InterconnectType=Fibre Channel; Manufacturer=BROCADE; Power=On; Health=OK; UID=Off; ManagementIP=192.168.247.254}} Total : 4 interconnect modules installed, 4 powered on. IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK InterconnectList : {@{Bay=1; InterconnectType=Ethernet; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=192.168.244.127}, @{Bay=2; InterconnectType=Ethernet; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=192.168.244.161}, @{Bay=3; InterconnectType=Fibre Channel; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=0.0.0.0}, @{Bay=4; InterconnectType=Fibre Channel; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=192.168.245.86}...} Total : 8 interconnect modules installed, 8 powered on. </dev:code> <dev:remarks> <maml:para>This command shows that the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAInterconnectList IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectList : {@{Bay=1; InterconnectType=Ethernet; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=0.0.0.0}, @{Bay=2; InterconnectType=Ethernet; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=192.168.246.113}, @{Bay=3; InterconnectType=Fibre Channel; Manufacturer=BROCADE; Power=On; Health=OK; UID=Off; ManagementIP=192.168.246.242}, @{Bay=4; InterconnectType=Fibre Channel; Manufacturer=BROCADE; Power=On; Health=OK; UID=Off; ManagementIP=192.168.247.254}} Totals : 4 interconnect modules installed, 4 powered on. IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK InterconnectList : {@{Bay=1; InterconnectType=Ethernet; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=192.168.244.127}, @{Bay=2; InterconnectType=Ethernet; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=192.168.244.161}, @{Bay=3; InterconnectType=Fibre Channel; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=0.0.0.0}, @{Bay=4; InterconnectType=Fibre Channel; Manufacturer=HP; Power=On; Health=OK; UID=Off; ManagementIP=192.168.245.86}...} Totals : 8 interconnect modules installed, 8 powered on. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAInterconnectPortMap</command:name> <maml:description> <maml:para>Gets the port mapping for the interconnect specified by the bay number.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAInterconnectPortMap</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAInterconnectPortMap cmdlet gets the port mapping for the interconnect specified by the bay number. You must have explicit access to a bay given by the Add-HPEOAUserBay command. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAInterconnectPortMap</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Specifies the bay number(s) of the interconnect for which the port map will be retrieved. The bay number(s) can be specified as All|<Bay number>|<bay number>[,|-<bay number>]. The default value All is used if bay is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAInterconnectPortMap requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAInterconnectPortMap -Connection $connection -Bay $bay IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectPortMap : {@{Bay=1; Name=HP 1/10Gb VC-Enet Module; Type=Ethernet; Width=Single; Status=OK; Port=System.Management.Automation.PSObject[]}, @{Bay=2; Name=HP 1/10Gb VC-Enet Module; Type=Ethernet; Width=Single; Status=Mismatch; Port=System.Management.Automation.PSObject[]}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK InterconnectPortMap : {@{Bay=1; Name=HP 1/10Gb-F VC-Enet Module; Type=Ethernet; Width=Single; Status=OK; Port=System.Management.Automation.PSObject[]}, @{Bay=2; Name=HP 1/10Gb-F VC-Enet Module; Type=Ethernet; Width=Single; Status=OK; Port=System.Management.Automation.PSObject[]}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with bay.</maml: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-HPEOAInterconnectPortMap -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectPortMap : {@{Bay=1; Name=HP 1/10Gb VC-Enet Module; Type=Ethernet; Width=Single; Status=OK; Port=System.Management.Automation.PSObject[]}, @{Bay=2; Name=HP 1/10Gb VC-Enet Module; Type=Ethernet; Width=Single; Status=Mismatch; Port=System.Management.Automation.PSObject[]}, @{Bay=3; Name=absent}, @{Bay=4; Name=absent}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK InterconnectPortMap : {@{Bay=1; Name=HP 1/10Gb-F VC-Enet Module; Type=Ethernet; Width=Single; Status=OK; Port=System.Management.Automation.PSObject[]}, @{Bay=2; Name=HP 1/10Gb-F VC-Enet Module; Type=Ethernet; Width=Single; Status=OK; Port=System.Management.Automation.PSObject[]}, @{Bay=3; Name=HP 4Gb VC-FC Module; Type=Fibre; Width=Single; Status=Mismatch; Port=System.Management.Automation.PSObject[]}, @{Bay=4; Name=HP 4Gb VC-FC Module; Type=Fibre; Width=Single; Status=Mismatch; Port=System.Management.Automation.PSObject[]}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, the default value All is used.</maml: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:\> $connection | Get-HPEOAInterconnectPortMap IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectPortMap : {@{Bay=1; Name=HP 1/10Gb VC-Enet Module; Type=Ethernet; Width=Single; Status=OK; Port=System.Management.Automation.PSObject[]}, @{Bay=2; Name=HP 1/10Gb VC-Enet Module; Type=Ethernet; Width=Single; Status=Mismatch; Port=System.Management.Automation.PSObject[]}, @{Bay=3; Name=absent}, @{Bay=4; Name=absent}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK InterconnectPortMap : {@{Bay=1; Name=HP 1/10Gb-F VC-Enet Module; Type=Ethernet; Width=Single; Status=OK; Port=System.Management.Automation.PSObject[]}, @{Bay=2; Name=HP 1/10Gb-F VC-Enet Module; Type=Ethernet; Width=Single; Status=OK; Port=System.Management.Automation.PSObject[]}, @{Bay=3; Name=HP 4Gb VC-FC Module; Type=Fibre; Width=Single; Status=Mismatch; Port=System.Management.Automation.PSObject[]}, @{Bay=4; Name=HP 4Gb VC-FC Module; Type=Fibre; Width=Single; Status=Mismatch; Port=System.Management.Automation.PSObject[]}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAInterconnectPowerDelay</command:name> <maml:description> <maml:para>Gets the PowerDelay status for the specified interconnects or range of interconnects.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAInterconnectPowerDelay</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAInterconnectPowerDelay cmdlet gets the PowerDelay status for the specified interconnects or range of interconnects. You must have explicit access to the specified bay. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAInterconnectPowerDelay</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Specifies the bay number(s) of the interconnect(s) for which power delay setting will be retrieved. The bay number(s) can be specified as All|<Bay number>|<bay number>[,|-<bay number>]. The default value All is used if bay is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAInterconnectPowerDelay requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAInterconnectPowerDelay -Connection $connection -Bay $bay IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK CurrentPowerDelayStatus : Not in Progress PowerDelayDetail : {@{Bay=1; Device=HP 1Gb Ethernet Pass-Thru Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=2; Device=GbE2c Ethernet Blade Switch; PowerDelayState=Disabled; DelaySeconds=0}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK CurrentPowerDelayStatus : Not in Progress PowerDelayDetail : {@{Bay=1; Device=HP 1/10Gb-F VC-Enet Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=2; Device=HP 1/10Gb-F VC-Enet Module; PowerDelayState=Disabled; DelaySeconds=0}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with bay.</maml: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-HPEOAInterconnectPowerDelay -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK CurrentPowerDelayStatus : Not in Progress PowerDelayDetail : {@{Bay=1; Device=HP 1Gb Ethernet Pass-Thru Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=2; Device=GbE2c Ethernet Blade Switch; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=3; Device=HP 8/24c SAN Switch Pwr Pk+ Blad; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=4; Device=HP 8/24c SAN Switch Pwr Pk+ Blad; PowerDelayState=Disabled; DelaySeconds=0}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK CurrentPowerDelayStatus : Not in Progress PowerDelayDetail : {@{Bay=1; Device=HP 1/10Gb-F VC-Enet Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=2; Device=HP 1/10Gb-F VC-Enet Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=3; Device=HP 4Gb VC-FC Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=4; Device=HP 4Gb VC-FC Module; PowerDelayState=Disabled; DelaySeconds=0}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, the default value All is used.</maml: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:\> $connection | Get-HPEOAInterconnectPowerDelay IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK CurrentPowerDelayStatus : Not in Progress PowerDelayDetail : {@{Bay=1; Device=HP 1Gb Ethernet Pass-Thru Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=2; Device=GbE2c Ethernet Blade Switch; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=3; Device=HP 8/24c SAN Switch Pwr Pk+ Blad; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=4; Device=HP 8/24c SAN Switch Pwr Pk+ Blad; PowerDelayState=Disabled; DelaySeconds=0}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK CurrentPowerDelayStatus : Not in Progress PowerDelayDetail : {@{Bay=1; Device=HP 1/10Gb-F VC-Enet Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=2; Device=HP 1/10Gb-F VC-Enet Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=3; Device=HP 4Gb VC-FC Module; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=4; Device=HP 4Gb VC-FC Module; PowerDelayState=Disabled; DelaySeconds=0}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAInterconnectSession</command:name> <maml:description> <maml:para>Gets which users have serial console sessions in progress for each interconnect.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAInterconnectSession</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAInterconnectSession cmdlet gets which users have serial console sessions in progress for each interconnect. A list of connection objects must be provided as a parameter. OA administrators or OA operators with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAInterconnectSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAInterconnectSession requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAInterconnectSession -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK InterconnectSession : {@{InterconnectBay=1; User=Administrator}, @{InterconnectBay=2; User=Admin}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : No Interconnect remote console sessions were detected. </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAInterconnectSession IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK InterconnectSession : {@{InterconnectBay=1; User=Administrator}, @{InterconnectBay=2; User=Admin}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : No Interconnect remote console sessions were detected. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAInterconnectStatus</command:name> <maml:description> <maml:para>Gets interconnect status information; UID state and health state.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAInterconnectStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAInterconnectStatus cmdlet gets interconnect status information; UID state and health state. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAInterconnectStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the interconnect(s) for which status is to be retrieved. The bay number(s) can be specified as All|<Bay number>|<bay number>[,|-<bay number>]. The default value All is used if bay is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAInterconnectStatus requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAInterconnectStatus -Connection $connection -Bay $bay IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectModule : {@{Status=OK; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=Off; Powered=On; DiagnosticStatus=; Bay=1}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK InterconnectModule : {@{Status=OK; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=On; Powered=On; DiagnosticStatus=; Bay=1}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Bay.</maml: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-HPEOAInterconnectStatus -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectModule : {@{Status=OK; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=Off; Powered=On; DiagnosticStatus=; Bay=1}, @{Status=OK; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=Off; Powered=On; DiagnosticStatus=; Bay=2}, @{Status=OK; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=Off; Powered=On; DiagnosticStatus=; Bay=3}, @{Status=OK; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=Off; Powered=On; DiagnosticStatus=; Bay=4}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK InterconnectModule : {@{Status=OK; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=Off; Powered=On; DiagnosticStatus=; Bay=1}, @{Status=Degraded; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=Off; Powered=On; DiagnosticStatus=; Bay=2}, @{InterconnectModuleType=No Interconnect Module Installed; Bay=3}, @{InterconnectModuleType=No Interconnect Module Installed; Bay=4}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Parameter Bay is not input, so the default value ALL is used, and the information of all the bays is displayed.</maml: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:\> $server | Get-HPEOAInterconnectStatus IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK InterconnectModule : {@{Status=OK; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=Off; Powered=On; DiagnosticStatus=; Bay=4}} IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK InterconnectModule : {@{Status=OK; Thermal=OK; CPUFault=OK; HealthLED=OK; UID=Off; Powered=On; DiagnosticStatus=; Bay=1}} </dev:code> <dev:remarks> <maml:para>In this example connection and bay information in $server is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOALanguage</command:name> <maml:description> <maml:para>Gets all language support packs installed.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOALanguage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOALanguage cmdlet gets all the language support packs installed. Language support packs enable OA GUI to display information in languages other than English.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator, OA operator, and OA user access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOALanguage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOALanguage requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOALanguage -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK LanguageSupportPacks : {@{Language=English; Version=4.11; Date=Jan 16 2014; Code=en; FileName=Embedded}, @{Language=Chinese; Version=4.20; Date=Mar 21 2014; Code=zh; FileName=OA_420_140321_zh.lpk}} LanguageSummary : Found 2 language support pack(s). Language support packs enables OA GUI to display information in languages other than English. </dev:code> <dev:remarks> <maml:para>This example shows the languages returns from OA. $connection is Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection | Get-HPEOALanguage IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK LanguageSupportPacks : {@{Language=English; Version=4.11; Date=Jan 16 2014; Code=en; FileName=Embedded}, @{Language=Chinese; Version=4.20; Date=Mar 21 2014; Code=zh; FileName=OA_420_140321_zh.lpk}} LanguageSummary : Found 2 language support pack(s). Language support packs enables OA GUI to display information in languages other than English. </dev:code> <dev:remarks> <maml:para>This example uses the cmdlet in pipeline. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOALDAPCertificate</command:name> <maml:description> <maml:para>Gets all LDAP certificates that are in effect on the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOALDAPCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOALDAPCertificate cmdlet gets all LDAP certificates that are in effect on the Onboard Administrator. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOALDAPCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOALDAPCertificate requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOALDAPCertificate -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK LDAPCertificate : {@{IssuedTo=OA-002481A4862D; MD5Fingerprint=53:8B:BA:CA:B9:8F:80:CC:F2:5C:D7:26:E0:80:52:7F; CertificateContent=-----BEGIN CERTIFICATE----- MIICHzCCAYgCCQDSVPR6qsMZzTANBgkqhkiG9w0BAQQFADBUMRgwFgYDVQQKEw9I ZXdsZXR0LVBhY2thcmQxHjAcBgNVBAsTFU9uYm9hcmQgQWRtaW5pc3RyYXRvcjEY MBYGA1UEAxMPT0EtMDAyNDgxQTQ4NjJEMB4XDTA2MDYxNDAwMDEwMloXDTE2MDYx MTAwMDEwMlowVDEYMBYGA1UEChMPSGV3bGV0dC1QYWNrYXJkMR4wHAYDVQQLExVP bmJvYXJkIEFkbWluaXN0cmF0b3IxGDAWBgNVBAMTD09BLTAwMjQ4MUE0ODYyRDCB nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA37xqnY3GUE4Og4C4jL4fvdttFNPu bCj1gxy25GOb0MjRn5AUA1Z62IH1lMxDpzat/EKUg22e1gTybTVdzClPlLR0chdK 432dsm32Ig7HJO//3oX8KWVl6QpS7oYaUVB0ppWOs3OHD5RbIU73V/e+GNra9Q9b E/tczdu/2Vq+3DcCAwEAATANBgkqhkiG9w0BAQQFAAOBgQCXunPKEAASFcXjYXzQ EO16J3g8j4MnpI0Sl2foWg7nQLhgcI1BjmX5XTddJ+zoawG5y4t+1g8mT/ChNE1w 53fqdY8L77iydMZj3UsJ08zR62I/XlFtT/cgM6asl2fq115BP0gfw8hN1fZPcQ20 6wKTBaV++2vq+NLFy7xlunKD9g== -----END CERTIFICATE----- }} IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : No certificates were found. </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOALDAPCertificate IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK LDAPCertificate : {@{IssuedTo=OA-002481A4862D; MD5Fingerprint=53:8B:BA:CA:B9:8F:80:CC:F2:5C:D7:26:E0:80:52:7F; CertificateContent=-----BEGIN CERTIFICATE----- MIICHzCCAYgCCQDSVPR6qsMZzTANBgkqhkiG9w0BAQQFADBUMRgwFgYDVQQKEw9I ZXdsZXR0LVBhY2thcmQxHjAcBgNVBAsTFU9uYm9hcmQgQWRtaW5pc3RyYXRvcjEY MBYGA1UEAxMPT0EtMDAyNDgxQTQ4NjJEMB4XDTA2MDYxNDAwMDEwMloXDTE2MDYx MTAwMDEwMlowVDEYMBYGA1UEChMPSGV3bGV0dC1QYWNrYXJkMR4wHAYDVQQLExVP bmJvYXJkIEFkbWluaXN0cmF0b3IxGDAWBgNVBAMTD09BLTAwMjQ4MUE0ODYyRDCB nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA37xqnY3GUE4Og4C4jL4fvdttFNPu bCj1gxy25GOb0MjRn5AUA1Z62IH1lMxDpzat/EKUg22e1gTybTVdzClPlLR0chdK 432dsm32Ig7HJO//3oX8KWVl6QpS7oYaUVB0ppWOs3OHD5RbIU73V/e+GNra9Q9b E/tczdu/2Vq+3DcCAwEAATANBgkqhkiG9w0BAQQFAAOBgQCXunPKEAASFcXjYXzQ EO16J3g8j4MnpI0Sl2foWg7nQLhgcI1BjmX5XTddJ+zoawG5y4t+1g8mT/ChNE1w 53fqdY8L77iydMZj3UsJ08zR62I/XlFtT/cgM6asl2fq115BP0gfw8hN1fZPcQ20 6wKTBaV++2vq+NLFy7xlunKD9g== -----END CERTIFICATE----- }} IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : No certificates were found. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOALDAPGroup</command:name> <maml:description> <maml:para>Gets the LDAP group information.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOALDAPGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOALDAPGroup cmdlet gets the LDAP group information. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOALDAPGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Group for which LDAP information has to be retrieved. The group name or 'ALL' are valid values. If you specify ALL, a list of all the LDAP groups appears. If Group is not specified, the default value All is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOALDAPGroup requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOALDAPGroup -Connection $connection -Group AutoTest-Admin IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK GroupName : AutoTest-Admin Description : AutoTest-Admin Rights : Admin ServerBayAccessList : 1 1A 1B 2 2A 2B 3 3A 3B 4 4A 4B 5 5A 5B 6 6A 6B 7 7A 7B 8 8A 8B 9 9A 9B 10 10A 10B 11 11A 11B 12 12A 12B 13 13A 13B 14 14A 14B 15 15A 15B 16 16A 16B InterconnectBayAccessList : 1 2 3 4 5 6 7 8 OAAccess : Yes IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : Error StatusMessage : The LDAP group does not exist. </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Group.</maml: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-HPEOALDAPGroup -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK LDAPGroupList : {@{PrivilegeLevel=Admin; LDAPGroupDescription=AutoTest-Admin; LDAPGroupName=AutoTest-Admin}, @{PrivilegeLevel=Operator; LDAPGroupDescription=AutoTest-Opt; LDAPGroupName=AutoTest-Opt}, @{PrivilegeLevel=User; LDAPGroupDescription=AutoTest_User; LDAPGroupName=AutoTest_User}} IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : No LDAP groups were detected. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Group parameter is not provided, the default value All is used and show the ldap group list.</maml: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:\> $connection | Get-HPEOALDAPGroup IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK LDAPGroupList : {@{PrivilegeLevel=Admin; LDAPGroupDescription=AutoTest-Admin; LDAPGroupName=AutoTest-Admin}, @{PrivilegeLevel=Operator; LDAPGroupDescription=AutoTest-Opt; LDAPGroupName=AutoTest-Opt}, @{PrivilegeLevel=User; LDAPGroupDescription=AutoTest_User; LDAPGroupName=AutoTest_User}} IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : No LDAP groups were detected. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOALDAPInfo</command:name> <maml:description> <maml:para>Gets the LDAP settings, including enabled or disabled status, LDAP server, LDAP port, search contexts, and NT mapping state.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOALDAPInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOALDAPInfo cmdlet gets the LDAP settings, including enabled or disabled status, LDAP server, LDAP port, search contexts, and NT mapping state. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOALDAPInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOALDAPInfo requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOALDAPInfo -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Enabled : Disabled LocalUsersEnabled : Enabled NTNameMapping : Disabled DirectoryServer : DirectoryServerSSLPort : 1 SearchContext1 : SearchContext2 : SearchContext3 : SearchContext4 : SearchContext5 : SearchContext6 : AutoTest IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Enabled : Disabled LocalUsersEnabled : Enabled NTNameMapping : Disabled DirectoryServer : DirectoryServerSSLPort : 0 DirectoryServerGCSSLPort : Disabled SearchContext1 : SearchContext2 : SearchContext3 : SearchContext4 : SearchContext5 : SearchContext6 : </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOALDAPInfo IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Enabled : Disabled LocalUsersEnabled : Enabled NTNameMapping : Disabled DirectoryServer : DirectoryServerSSLPort : 1 SearchContext1 : SearchContext2 : SearchContext3 : SearchContext4 : SearchContext5 : SearchContext6 : AutoTest IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Enabled : Disabled LocalUsersEnabled : Enabled NTNameMapping : Disabled DirectoryServer : DirectoryServerSSLPort : 0 DirectoryServerGCSSLPort : Disabled SearchContext1 : SearchContext2 : SearchContext3 : SearchContext4 : SearchContext5 : SearchContext6 : </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOALoginBanner</command:name> <maml:description> <maml:para>Gets the login banner settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOALoginBanner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOALoginBanner cmdlet gets the login banner settings. The login banner settings include login banner display on user login enabled/disabled and currently configured login banner text (if any).</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator, OA operator, or OA user acccess is required to execute this cmdlet. The cmdlet is not available on OA3.x.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOALoginBanner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOALoginBanner requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Get-HPEOALoginBanner -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Status : Enabled LoginBannerText : Please note: The Enclosure has to be used following the rules below ......... IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Status : Disabled LoginBannerText : </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Get-HPEOALoginBanner IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Status : Enabled LoginBannerText : Please note: The Enclosure has to be used following the rules below ......... IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Status : Disabled LoginBannerText : </dev:code> <dev:remarks> <maml:para>This example shows that $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAModuleVersion</command:name> <maml:description> <maml:para>Gets the module details for the HPEOACmdlets.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAModuleVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAModuleVersion cmdlet gets the module details for the HPEOACmdlets module. The details include name of file, path, description, GUID, version, and supported UI Cultures with respective version. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAModuleVersion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with HPE OA Cmdlets is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAModuleVersion Name : HPEOACmdlets Path : C:\Program Files (x86)\Hewlett Packard Enterprise\PowerShell\Modules\HPEOACmdlets\HPEOACmdlets.dll Description : Scripting Tools for Windows PowerShell : OA Cmdlets create an interface to HPE Onboard Administrator(OA). These cmdlets can be used to get and set OA settings in HPE BladeSystem c3000 and c7000 Enclosures. GUID : 4a26845a-9a75-482c-8850-75fa4c1e6698 Version : 2.0.0.0 CurrentUICultureName : en-US CurrentUICultureVersion : 2.0.0.0 AvailableUICulture : {@{UICultureName=en-US; UICultureVersion=2.0.0.0}, @{UICultureName=zh-CN; UICultureVersion=2.0.0.0}, @{UICultureName=ja-JP; UICultureVersion=2.0.0.0}} </dev:code> <dev:remarks> <maml:para>This example shows the output format of this cmdlet. No connection object or parameter is required for this cmdlet.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOANetworkSetting</command:name> <maml:description> <maml:para>Gets Onboard Administrator network settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOANetworkSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOANetworkSetting cmdlet gets the following Onboard Administrator network settings: - Enclosure - IPv4 information - IPv6 information - DHCP state - Dynamic DNS state - IP address subnet mask - Gateway address - Primary and secondary DNS addresses - MAC address - HTTP and HTTPS server status - SNMP status - SSH status - FIPS Mode - Trusted Host status - HPSIM trust mode status - Telnet status - AlertMail status - NTP status - Network link settings - Enclosure IP mode - GUI login status - Active Health System status - VLAN status. VLAN ID information displays only when VLAN is enabled. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOANetworkSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of OA if Target selected is OA. If the bay number of the Onboard Administrator is not specified, the command defaults to the Active Onboard Administrator. Possible values can be specified as All|<Bay number>|<bay number>[,|-<bay number>].</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target device for which the network information is to be retrieved. Valid values are OA and All. If all is selected, general network settings are displayed. Default value is All. If the parameter is set as OA, parameter 'Bay' can be used to specify OA bay number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOANetworkSetting requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOANetworkSetting -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK OnboardAdministratorNetworkSettings : @{IPv4Information=; IPv6Information=; GeneralInformation=} OnboardAdministratorProtocolStatus : @{WebHTTPHTTPS=Enabled; SNMP=Enabled; SecureSH=Enabled; EncryptionMode=Normal; TrustedHosts=Disabled; HPSIMTrustMode=Disabled; Telnet=Enabled; AlertMail=; XMLReply=Enabled; NTP=; LinkLossFailover=Disabled; LinkLossInterval=60 seconds; EnclosureIPMode=Disabled; GUILoginDetail=Enabled; VLAN=Disabled} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK EnclosureNetworkSettings : @{IPv6Information=} OnboardAdministratorNetworkSettings : @{IPv4Information=; IPv6Information=; GeneralInformation=} OnboardAdministratorProtocolStatus : @{WebHTTPHTTPS=Enabled; SNMP=Enabled; SecureSH=Enabled; FIPSMode=Off; TrustedHosts=Disabled; HPSIMTrustMode=Disabled; Telnet=Disabled; AlertMail=; XMLReply=Enabled; NTP=; LinkLossFailover=Enabled; LinkLossInterval=45 seconds; EnclosureIPMode=Disabled; GUILoginDetail=Enabled; ActiveHealthSystem=Enabled; VLAN=Disabled; EnclosureiLOFederationSupport=} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter. The default value “ALL” for Target parameter is used when Target is not specified.</maml: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:\> $server | Get-HPEOANetworkSetting -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK EnclosureNetworkSettings : @{IPv6Information=} OnboardAdministrator : {@{Name=westwind; IPv4Information=; IPv6Information=; GeneralInformation=; AdvancedSettings=; Bay=1}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{Name=NorthBeggar; IPv4Information=; IPv6Information=; GeneralInformation=; Bay=1}} </dev:code> <dev:remarks> <maml:para>In this example the specified bay of the Onboard Administrator for which details are retrieved from the cmdlet. Connection and Target information in $server is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAPasswordSetting</command:name> <maml:description> <maml:para>Gets the current minimum password length and strong password settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAPasswordSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAPasswordSetting cmdlet gets the current minimum password length and strong password settings. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAPasswordSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAPasswordSetting requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAPasswordSetting -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK StrongPasswords : Disabled MinimumPasswordLength : 3 IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK StrongPasswords : Disabled MinimumPasswordLength : 3 </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAPasswordSetting IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK StrongPasswords : Disabled MinimumPasswordLength : 3 IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK StrongPasswords : Disabled MinimumPasswordLength : 3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAPower</command:name> <maml:description> <maml:para>Gets the current power configuration.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAPower cmdlet gets the current power configuration. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAPower requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAPower -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK PowerMode : Not Redundant DynamicPower : Enabled SetPowerLimit : Not Set PowerCapacity : 4800 Watts DC PowerAvailable : 4193 Watts DC PowerAllocated : 607 Watts DC PresentPower : 218 Watts AC PowerLimit : 5837 Watts AC IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK PowerMode : Redundant DynamicPower : Disabled SetPowerLimit : Not Set PowerCapacity : 1200 Watts DC PowerAvailable : 650 Watts DC PowerAllocated : 550 Watts DC PresentPower : 283 Watts AC PowerLimit : 1459 Watts AC </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAPower IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK PowerMode : Not Redundant DynamicPower : Enabled SetPowerLimit : Not Set PowerCapacity : 4800 Watts DC PowerAvailable : 4193 Watts DC PowerAllocated : 607 Watts DC PresentPower : 218 Watts AC PowerLimit : 5837 Watts AC IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK PowerMode : Redundant DynamicPower : Disabled SetPowerLimit : Not Set PowerCapacity : 1200 Watts DC PowerAvailable : 650 Watts DC PowerAllocated : 550 Watts DC PresentPower : 254 Watts AC PowerLimit : 1459 Watts AC </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOADiscoveryInfo</command:name> <maml:description> <maml:para>Gets information in OA discovery. </maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOADiscoveryInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOADiscoveryInfo cmdlet gets information in OA discovery. The cmdlet works when xml reply is enabled. See Set-HPEOAXMLReply for reference. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOADiscoveryInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this prompt, Get-HPEOADiscoveryInfo requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOADiscoveryInfo -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK MP : @{ST=1; PRIM=true; PN=c3000 Tray with embedded DDR2 Onboard Administrator; FWRI=3.11; HWRI=7.71; SN=PAMMT0C9VXA09J; UUID=18PAMMT0C9VXA09J; STE=false; USESTE=false; SSO=false; CIMOM=false} INFRA2 : @{RACK=southking; ENCL=11111; DATETIME=2014-07-25T05:33:02-05:00; TIMEZONE=US/Central; PN=BladeSystem c3000 Enclosure; ASSET=; STATUS=OK; DIAG=; ENCL_SN=USE924MVA1; PART=437506-B21; UUID=09USE924MVA1; UIDSTATUS=OFF; ADDR=A9FE01A1; DIM=; BLADES=; SWITCHES=; MANAGERS=; LCDS=; FANS=; POWER=; TEMPS=; VCM=; KVM_PRESENT=no; VM=} RK_TPLGY : @{RUID=09USE924MVA1; ICMB=; CNT=1} IP : 192.168.242.64 Hostname : southking.company.net StatusType : OK StatusMessage : OK MP : @{ST=1; PRIM=true; PN=c3000 Tray with embedded DDR2 Onboard Administrator; FWRI=4.22; HWRI=65.48; SN=PAMMT0A9VWY01N; UUID=18PAMMT0A9VWY01N; STE=false; USESTE=false; SSO=true; CIMOM=false; ERS=2; IRS=192.168.243.56:7906} INFRA2 : @{RACK=southking; ENCL=Southking; DATETIME=2014-07-25T18:34:22-07:00; TIMEZONE=MST; PN=BladeSystem c3000 Enclosure; ASSET=123456; STATUS=Degraded; DIAG=; ENCL_SN=serialnum1; PART=2222222222; UUID=09serialnum1; UIDSTATUS=ON; ADDR=A9FE0150; SOLUTIONSID=0000000000000000; DIM=; BLADES=; SWITCHES=; MANAGERS=; LCDS=; FANS=; POWER=; TEMPS=; VCM=; KVM_PRESENT=yes; VM=} RK_TPLGY : @{RUID=09serialnum1; ICMB=; CNT=1} SPATIAL : @{DISCOVERY_RACK=Not Supported; DISCOVERY_DATA=Server does not support Discovery Services; TAG_VERSION=; RACK_ID=; RACK_ID_PN=; RACK_cUUID=; RACK_DESCRIPTION=; RACK_UHEIGHT=; UPOSITION=; ULOCATION=; CUUID=65733930-6972-6C61-6E75-6D3120202020; UHEIGHT=600; UOFFSET=2; DEVICE_UPOSITION=} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOADiscoveryInfo IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK MP : @{ST=1; PRIM=true; PN=c3000 Tray with embedded DDR2 Onboard Administrator; FWRI=3.11; HWRI=7.71; SN=PAMMT0C9VXA09J; UUID=18PAMMT0C9VXA09J; STE=false; USESTE=false; SSO=false; CIMOM=false} INFRA2 : @{RACK=southking; ENCL=11111; DATETIME=2014-07-25T05:33:02-05:00; TIMEZONE=US/Central; PN=BladeSystem c3000 Enclosure; ASSET=; STATUS=OK; DIAG=; ENCL_SN=USE924MVA1; PART=437506-B21; UUID=09USE924MVA1; UIDSTATUS=OFF; ADDR=A9FE01A1; DIM=; BLADES=; SWITCHES=; MANAGERS=; LCDS=; FANS=; POWER=; TEMPS=; VCM=; KVM_PRESENT=no; VM=} RK_TPLGY : @{RUID=09USE924MVA1; ICMB=; CNT=1} IP : 192.168.242.64 Hostname : southking.company.net StatusType : OK StatusMessage : OK MP : @{ST=1; PRIM=true; PN=c3000 Tray with embedded DDR2 Onboard Administrator; FWRI=4.22; HWRI=65.48; SN=PAMMT0A9VWY01N; UUID=18PAMMT0A9VWY01N; STE=false; USESTE=false; SSO=true; CIMOM=false; ERS=2; IRS=192.168.243.56:7906} INFRA2 : @{RACK=southking; ENCL=Southking; DATETIME=2014-07-25T18:34:22-07:00; TIMEZONE=MST; PN=BladeSystem c3000 Enclosure; ASSET=123456; STATUS=Degraded; DIAG=; ENCL_SN=serialnum1; PART=2222222222; UUID=09serialnum1; UIDSTATUS=ON; ADDR=A9FE0150; SOLUTIONSID=0000000000000000; DIM=; BLADES=; SWITCHES=; MANAGERS=; LCDS=; FANS=; POWER=; TEMPS=; VCM=; KVM_PRESENT=yes; VM=} RK_TPLGY : @{RUID=09serialnum1; ICMB=; CNT=1} SPATIAL : @{DISCOVERY_RACK=Not Supported; DISCOVERY_DATA=Server does not support Discovery Services; TAG_VERSION=; RACK_ID=; RACK_ID_PN=; RACK_cUUID=; RACK_DESCRIPTION=; RACK_UHEIGHT=; UPOSITION=; ULOCATION=; CUUID=65733930-6972-6C61-6E75-6D3120202020; UHEIGHT=600; UOFFSET=2; DEVICE_UPOSITION=} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOARackInfo</command:name> <maml:description> <maml:para>Gets the rack information for the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOARackInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOARackInf cmdlet gets the rack information for the enclosure. A list of connection objects must be provided as a parameter. All users can execute this cmdlet. The cmdlet is not available on OA 3.x. </maml:para> <maml:para>NOTE. If XML reply is disabled, the result contains 4 rack information properties only: ProductDescription, PartNumber, RackIdentifier, and RackUHeigh. If XML reply is enabled, more information is output in the result. See Set-HPEOAXMLReply for reference.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOARackInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOARackInfo requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Get-HPEOARackInfo -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ProductDescription : HP 42U Intelligent Series Rack PartNumber : BW946A RackIdentifier : CN82190004 RackUHeight : 42 IP : 192.168.242.63 Hostname : westwind.company.net StatusType : Error StatusMessage : Location hardware not found (No hardware support) </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter. The first server is working with XML reply OFF.</maml: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:para> </maml:introduction> <dev:code>PS C:\> $connection | Get-HPEOARackInfo IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ProductDescription : HP 42U Intelligent Series Rack PartNumber : BW946A RackIdentifier : CN82190004 RackUHeight : 42 IP : 192.168.242.63 Hostname : westwind.company.net StatusType : Error StatusMessage : Location hardware not found (No hardware support) </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. The first server is working with XML reply OFF. </maml: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:para> </maml:introduction> <dev:code>PS C:\> Set-HPEOAXMLReply -Connection $c1 -State Enable IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK DiscoveryRack : Supported DiscoveryData : Valid TagVersion : 1 RackIdentifier : CN82190004 PartNumber : BW946A RackcUUID : 34395742-4136-4E43-3832-313930303034 ProductDescription : HP 42U Intelligent Series Rack RackUHeight : 42 UPosition : 23 ULocation : F cUUID : 47533930-3045-3030-3130-463320202020 UHeight : 1000 UOffset : 2 DeviceUPosition : 21 </dev:code> <dev:remarks> <maml:para>In this example XML reply is ON, which shows more information. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOARackName</command:name> <maml:description> <maml:para>Gets the user defined rack name setting for the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOARackName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOARackName cmdlet gets the user defined rack name setting for the enclosure. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOARackName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOARackName requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOARackName -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK RackName : Rack12 IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK RackName : Rack3 </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOARackName IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK RackName : Rack12 IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK RackName : Rack3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOARemoteSupport</command:name> <maml:description> <maml:para>Gets Remote Support settings and information.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOARemoteSupport</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOARemoteSupport cmdlet gets Remote Support settings and information. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOARemoteSupport</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOARemoteSupport requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOARemoteSupport -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Status : Disabled ConnectionType : None OnlineRegistrationComplete : No WebProxyServer : IRSHostname : IRSPort : 7906 LastSuccessfulRegistration : 0000-00-00T00:00:00 LastSuccessfulUnregistration : 0000-00-00T00:00:00 LastSuccessfulDataCollection : 0000-00-00T00:00:00 LastDataCollectionTransmission : 0000-00-00T00:00:00 LastSuccessfulServiceEvent : 0000-00-00T00:00:00 FailedDataCollectionAttempts : 0 FailedServiceEventAttempts : 0 MaintenanceMode : Disabled IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Status : Disabled ConnectionType : None OnlineRegistrationComplete : No WebProxyServer : IRSHostname : IRSPort : 7906 LastSuccessfulRegistration : 0000-00-00T00:00:00 LastSuccessfulUnregistration : 0000-00-00T00:00:00 LastSuccessfulDataCollection : 0000-00-00T00:00:00 LastDataCollectionTransmission : 0000-00-00T00:00:00 LastSuccessfulServiceEvent : 0000-00-00T00:00:00 FailedDataCollectionAttempts : 0 FailedServiceEventAttempts : 0 MaintenanceMode : Disabled </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOARemoteSupport IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Status : Disabled ConnectionType : None OnlineRegistrationComplete : No WebProxyServer : IRSHostname : IRSPort : 7906 LastSuccessfulRegistration : 0000-00-00T00:00:00 LastSuccessfulUnregistration : 0000-00-00T00:00:00 LastSuccessfulDataCollection : 0000-00-00T00:00:00 LastDataCollectionTransmission : 0000-00-00T00:00:00 LastSuccessfulServiceEvent : 0000-00-00T00:00:00 FailedDataCollectionAttempts : 0 FailedServiceEventAttempts : 0 MaintenanceMode : Disabled IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Status : Disabled ConnectionType : None OnlineRegistrationComplete : No WebProxyServer : IRSHostname : IRSPort : 7906 LastSuccessfulRegistration : 0000-00-00T00:00:00 LastSuccessfulUnregistration : 0000-00-00T00:00:00 LastSuccessfulDataCollection : 0000-00-00T00:00:00 LastDataCollectionTransmission : 0000-00-00T00:00:00 LastSuccessfulServiceEvent : 0000-00-00T00:00:00 FailedDataCollectionAttempts : 0 FailedServiceEventAttempts : 0 MaintenanceMode : Disabled </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOARemoteSupportEvents</command:name> <maml:description> <maml:para>Gets Remote Support events that have been sent.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOARemoteSupportEvents</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOARemoteSupportEvents cmdlet gets Remote Support events that have been sent. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet. The cmdlet is not available on OA 3.x.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOARemoteSupportEvents</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOARemoteSupportEvents requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Get-HPEOARemoteSupportEvents -Connection $connection | format-list IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : No Remote Support Service Events IP : 192.168.242.61 Hostname : northwind.company.net StatusType : OK StatusMessage : OK Event : {@{IdNumber=a383b4b5-bab1-453e-869f-c2a62724cc48; TimeGenerated=; EventType=Test; DeviceType=Enclosure; SerialNumber=serialnum2; Bay=0; PerceivedSeverity=Info; SubmissionStatus=OK}, @{IdNumber=6e4bed2e-8030-4ae7-915e-9fa4135dc383; TimeGenerated=; EventType=Test; DeviceType=Enclosure; SerialNumber=serialnum2; Bay=0; PerceivedSeverity=Info; SubmissionStatus=OK}, @{IdNumber=dee5f9c4-aa5c-4d24-80bf-0bb87ca7f2f6; TimeGenerated=; EventType=System; DeviceType=Power Supply; SerialNumber=5AGUD0AHLXP11P; Bay=5; PerceivedSeverity=Failed; SubmissionStatus=OK}} </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Get-HPEOARemoteSupportEvents IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Event : {} IP : 192.168.242.61 Hostname : northwind.company.net StatusType : OK StatusMessage : OK Event : {@{IdNumber=a383b4b5-bab1-453e-869f-c2a62724cc48; TimeGenerated=; EventType=Test; DeviceType=Enclosure; SerialNumber=serialnum2; Bay=0; PerceivedSeverity=Info; SubmissionStatus=OK}, @{IdNumber=6e4bed2e-8030-4ae7-915e-9fa4135dc383; TimeGenerated=; EventType=Test; DeviceType=Enclosure; SerialNumber=serialnum2; Bay=0; PerceivedSeverity=Info; SubmissionStatus=OK}, @{IdNumber=dee5f9c4-aa5c-4d24-80bf-0bb87ca7f2f6; TimeGenerated=; EventType=System; DeviceType=Power Supply; SerialNumber=5AGUD0AHLXP11P; Bay=5; PerceivedSeverity=Failed; SubmissionStatus=OK}} </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerBoot</command:name> <maml:description> <maml:para>Gets the boot settings for the specified servers.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerBoot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerBoot cmdlet gets the boot settings for the specified servers.</maml:para> <maml:para>NOTE. This cmdlet is not applicable to HP Integrity server blades.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerBoot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) for the server(s) for which boot settings have to be retrieved. Bay can be specified as All|<Bay number>|<bay number>[,|-<bay number>]. The default value for Bay is ALL.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerBoot requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerBoot -Connection $connection -Bay $bay IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{OneTimeBootFrom=None; IPLDevicesBootOrder=; Bay=1}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{OneTimeBootFrom=None; IPLDevicesBootOrder=System.String[]; Bay= 1}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Bay.</maml: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-HPEOAServerBoot -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{OneTimeBootFrom=None; IPLDevicesBootOrder=; Bay=1}, @{SupportBootOption=No; Bay=2}, @{OneTimeBootFrom=None; IPLDevicesBootOrder=; Bay=3}, @{OneTimeBootFrom=None; IPLDevicesBootOrder=System.String[]; Bay=4}...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{OneTimeBootFrom=None; IPLDevicesBootOrder=System.String[]; Bay=1}, @{IsPresent=No; Bay=2}, @{IsPresent=No; Bay=3}, @{OneTimeBootFrom=None; IPLDevicesBootOrder=System.String[]; Bay=4}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Parameter Bay is not input, so the default value ALL is used, and the information of all the bays is displayed.</maml: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:\> $server | Get-HPEOAServerBoot IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{OneTimeBootFrom=None; IPLDevicesBootOrder=; Bay= 1}, @{OneTimeBootFrom=None; IPLDevicesBootOrder=; Bay= 3}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{OneTimeBootFrom=None; IPLDevicesBootOrder=System.String[]; Bay= 1}} </dev:code> <dev:remarks> <maml:para>In this example connection and bay information in $server is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerDVD</command:name> <maml:description> <maml:para>Gets the DVD connection status for the specified server or range of servers.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerDVD</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerDVD cmdlet gets the DVD connection status for the specified server or range of servers. Different sides of the server bay cannot be designated within the same range.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerDVD</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) for the server(s) for which DVD connection status is to be retrieved. Bay can be specified as All|<Bay number>|<bay number>[,|-<bay number>]. If bay is not specified, the default value All is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerDVD requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerDVD -Connection $connection -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK DVDDrive : Absent ServerDVDconnection : {@{Bay=1; Connected=No; DeviceOrImageURL=}, @{Bay=2; Connected=; DeviceOrImageURL=Bay empty}} IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK DVDDrive : Present DVDMedia : Absent ServerDVDconnection : {@{Bay=1; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=2; Connected=; DeviceOrImageURL=Bay empty}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with bay.</maml: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-HPEOAServerDVD -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK DVDDrive : Absent ServerDVDconnection : {@{Bay=1; Connected=No; DeviceOrImageURL=}, @{Bay=2; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=3; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=4; Connected=No; DeviceOrImageURL=}...} IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK DVDDrive : Present DVDMedia : Absent ServerDVDconnection : {@{Bay=1; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=2; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=3; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=4; Connected=; DeviceOrImageURL=Bay empty}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, the default value All is used.</maml: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:\> $connection | Get-HPEOAServerDVD IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK DVDDrive : Absent ServerDVDconnection : {@{Bay=1; Connected=No; DeviceOrImageURL=}, @{Bay=2; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=3; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=4; Connected=No; DeviceOrImageURL=}...} IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK DVDDrive : Present DVDMedia : Absent ServerDVDconnection : {@{Bay=1; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=2; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=3; Connected=; DeviceOrImageURL=Bay empty}, @{Bay=4; Connected=; DeviceOrImageURL=Bay empty}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerFW</command:name> <maml:description> <maml:para>Gets the firmware log for the selected server or range of servers.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerFW</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerFW cmdlet gets a summary of firmware components in the specified server or range of servers. An exclamation mark (!) indicates firmware mismatch or missing firmware information.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerFW</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of server(s) for which firmware log is to be retrieved. Bay can be specified as All|<Bay number>|<bay number>[,|-<bay number>]. If the value for this paramater is not specified, then 'All' is taken as the default value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerFW requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerFW -Connection $connection -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerFW : {@{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK ServerFW : {@{Bay=1; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}}</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Bay.</maml: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-HPEOAServerFW -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerFW : {@{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=4; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=7; Discovered=Tue 2014-06-03 22:26:12; DeviceFWDetail=System.Management.Automation.PSObject[]}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK ServerFW : {@{Bay=1; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=3; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=4; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, the default value All is used.</maml: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:\> $connection | Get-HPEOAServerFW IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerFW : {@{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=4; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=7; Discovered=Tue 2014-06-03 22:26:12; DeviceFWDetail=System.Management.Automation.PSObject[]}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK ServerFW : {@{Bay=1; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=2; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=3; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}, @{Bay=4; Discovered=No; DeviceFWDetail=System.Management.Automation.PSObject[]}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerInfo</command:name> <maml:description> <maml:para>Gets server settings and details.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerInfo cmdlet gets the following server information: - Type - Name - Part number - Serial number - Asset tag - BIOS version - All CPU types and associated maximum speeds - Memory - NICs name and slot number - iLO name, iLO IP address, and iLO firmware version - Power Management Controller version - VLAN ID - IPv6 information </maml:para> <maml:para>MAC and WWN information is no longer included in the output for this command with Onboard Administrator firmware version 3.60. Different sides of the server bay cannot be designated within the same range.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) for server(s) for which server information has to be retrieved. Bay can be specified as All|<Bay number>|<bay number>[,|-<bay number>].</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerInfo requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerInfo -Connection $connection -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{Type=Server Blade; Manufacturer=HP; ProductName=ProLiant BL420c Gen8; PartNumber=690142-B21; SystemBoardSparePartNumber=654608-001; SerialNumber=6CU4100JM2; UUID=31303936-3234-4336-5534-3130304A4D32; ServerName=; AssetTag=[Unknown]; ROMVersion=I30 12/20/2013; CPUs=System.Management.Automation.PSObject[]; Memory=4096 MB; FLBAdapters=System.Management.Automation.PSObject[]; ManagementProcessorInformation=; ManagementProcessorIPv6=; Bay=1}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{BladeStatus=No Server Blade Installed; Bay=1}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Bay.</maml: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-HPEOAServerInfo -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{Type=Storage Blade; Manufacturer=HP; ProductName=D2200sb Storage Blade; PartNumber=AP880A; SystemBoardSparePartNumber=621520-002; SerialNumber=TWT329016W; ROMVersion=2.30; PartnerDevice=; Bay=1}, @{Type=Server Blade; Manufacturer=HP; ProductName=ProLiant BL420c Gen8; PartNumber=690142-B21; SystemBoardSparePartNumber=654608-001; SerialNumber=6CU4100JM2; UUID=31303936-3234-4336-5534-3130304A4D32; ServerName=; AssetTag=[Unknown]; ROMVersion=I30 12/20/2013; CPU=System.Management.Automation.PSObject[]; Memory=4096 MB; FLBAdapter=System.Management.Automation.PSObject[]; Mezzanine=System.Management.Automation.PSObject[]; PartnerDevice=; ManagementProcessorInformation=; ManagementProcessorIPv6=; Bay=2}, @{BladeStatus=No Server Blade Installed; Bay=3}, @{Type=Server Blade; Manufacturer=HP; ProductName=ProLiant BL660c Gen8; PartNumber=679118-B21; SystemBoardSparePartNumber=646410-001; SerialNumber=6CU4100JMF; UUID=31393736-3831-4336-5534-3130304A4D46; ServerName=PosidonPL; AssetTag=[Unknown]; ROMVersion=I32 12/20/2013; CPU=System.Management.Automation.PSObject[]; Memory=8192 MB; FLBAdapter=System.Management.Automation.PSObject[]; Mezzanine=System.Management.Automation.PSObject[]; ManagementProcessorInformation=; ManagementProcessorIPv6=; Bay=4}...} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{BladeStatus=No Server Blade Installed; Bay=1}, @{BladeStatus=No Server Blade Installed; Bay=2}, @{BladeStatus=No Server Blade Installed; Bay=3}, @{BladeStatus=No Server Blade Installed; Bay=4}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Parameter Bay is not input, so the default value ALL is used, and the information of all the bays is displayed.</maml: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:\> $server | Get-HPEOAServerInfo IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{BladeStatus=No Server Blade Installed; Bay= 2}, @{Type=Server Blade; Manufacturer=hp; ProductName=Integrity BL860c i2; PartNumber=AD399A; SystemBoardSparePartNumber=AD399-60001; SerialNumber=US23456789; UUID=7F4E6509-71B1-11DF-B726-BDACECB7B676; ServerName=Status is not available; AssetTag=assthpsim; ROMVersion=1.95; EFIVersion=2.02; CPUs=System.Management.Automation.PSObject[]; Memory=16384 MB; Flex10EmbeddedEthernet=; Mezzanines=System.Management.Automation.PSObject[]; ManagementProcessorInformation=; Bay= 3}, @{Type=Server Blade; Manufacturer=HP; ProductName=ProLiant BL620c G7; PartNumber=643786-B21; SystemBoardSparePartNumber=708070-001; SerialNumber=6CU4100JM4; UUID=37333436-3638-4336-5534-3130304A4D34; ServerName=; AssetTag=[Unknown]; ROMVersion=I25 07/01/2013; CPUs=System.Management.Automation.PSObject[]; Memory=16384 MB; FlexFabricEmbeddedEthernet=; Mezzanines=System.Management.Automation.PSObject[]; ManagementProcessorInformation=; Bay=4}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerBlade : {@{Type=Server Blade; Manufacturer=HP; ProductName=ProLiant BL420c Gen8; PartNumber=690142-B21; SystemBoardSparePartNumber=654608-001; SerialNumber=6CU4100JM2; UUID=31303936-3234-4336-5534-3130304A4D32; ServerName=; AssetTag=[Unknown]; ROMVersion=I30 12/20/2013; CPUs=System.Management.Automation.PSObject[]; Memory=4096 MB; FLBAdapters=System.Management.Automation.PSObject[]; ManagementProcessorInformation=; ManagementProcessorIPv6=; Bay=1}} </dev:code> <dev:remarks> <maml:para>In this example connection and bay information in $server is passed as parameter to the cmdlet through pipeline. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerList</command:name> <maml:description> <maml:para>Gets a brief description of all server blades to which the current user has access.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerList</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerList cmdlet gets a brief description of all server blades to which the current user has access. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>IPv6</maml:name> <maml:description> <maml:para>Specify this SwitchParameter to get a brief description of all server blades using IPv6.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>IPv6</maml:name> <maml:description> <maml:para>Specify this SwitchParameter to get a brief description of all server blades using IPv6.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerList requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerList -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerList : {@{Bay=1; iLOName=PSD-BL420G8-ILO; iLOIPAddress=192.168.243.178; Status=Other; Power=Off; UID=Off; Partner=}, @{Bay=2; iLOName=Absent; iLOIPAddress=; Status=; Power=; UID=; Partner=}, @{Bay=3; iLOName=Absent; iLOIPAddress=; Status=; Power=; UID=; Partner=}, @{Bay=4; iLOName=PSD-BL660G8-ILO; iLOIPAddress=192.168.243.186; Status=Other; Power=On; UID=Off; Partner=}...} Total : 3 server blades installed, 1 powered on. IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerList : {@{Bay=1; iLOName=kf2037; iLOIPAddress=192.168.243.100; Status=OK; Power=On; UID=On; Partner=}, @{Bay=2; iLOName=Absent; iLOIPAddress=; Status=; Power=; UID=; Partner=}, @{Bay=3; iLOName=kf3013; iLOIPAddress=192.168.243.102; Status=OK; Power=On; UID=On; Partner=}, @{Bay=4; iLOName=PSD-BL620G7-ILO; iLOIPAddress=192.168.243.184; Status=Degraded; Power=Off; UID=On; Partner=}...} Total : 3 server blades installed, 2 powered on. </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAServerList IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerList : {@{Bay=1; iLOName=PSD-BL420G8-ILO; iLOIPAddress=192.168.243.178; Status=Other; Power=Off; UID=Off; Partner=}, @{Bay=2; iLOName=Absent; iLOIPAddress=; Status=; Power=; UID=; Partner=}, @{Bay=3; iLOName=Absent; iLOIPAddress=; Status=; Power=; UID=; Partner=}, @{Bay=4; iLOName=PSD-BL660G8-ILO; iLOIPAddress=192.168.243.186; Status=Other; Power=On; UID=Off; Partner=}...} Total : 3 server blades installed, 1 powered on. IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerList : {@{Bay=1; iLOName=kf2037; iLOIPAddress=192.168.243.100; Status=OK; Power=On; UID=On; Partner=}, @{Bay=2; iLOName=Absent; iLOIPAddress=; Status=; Power=; UID=; Partner=}, @{Bay=3; iLOName=kf3013; iLOIPAddress=192.168.243.102; Status=OK; Power=On; UID=On; Partner=}, @{Bay=4; iLOName=PSD-BL620G7-ILO; iLOIPAddress=192.168.243.184; Status=Degraded; Power=Off; UID=On; Partner=}...} Total : 3 server blades installed, 2 powered on. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $serverListIPv6 = $connection | Get-HPEOAServerList -IPv6 IP : 192.168.10.101 Hostname : oa-c3k-01.powershvpn.com StatusType : OK StatusMessage : OK ServerList : {@{Bay=1; iLOName=bl660cgen9-01; iLOIPAddress=fe80::5a20:b1ff:fe07:e738; Type=LL}, @{Bay=2; iLOName=Absent; iLOIPAddress=; Type=}, @{Bay=3; iLOName=bl460cgen10-4; iLOIPAddress=fe80::fe15:b4ff:fe97:7994; Type=LL}, @{Bay=4; iLOName=Absent; iLOIPAddress=; Type=}...} Total : 4 server blades installed, 3 powered on. PS C:\> $serverListIPv6.ServerList Bay iLOName iLOIPAddress Type --- ------- ------------ ---- 1 bl660cgen9-01 fe80::5a20:b1ff:fe07:e738 LL 2 Absent 3 bl460cgen10-4 fe80::fe15:b4ff:fe97:7994 LL 4 Absent 5 Subsumed 6 Absent 7 ILOMXQ54509M3 fe80::eeb1:d7ff:fe7a:e3c4 LL 8 ILO123 fe80::fe15:b4ff:fe97:7852 LL </dev:code> <dev:remarks> <maml:para>In this example server details are shown with IPv6, where $connection object is passed through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerName</command:name> <maml:description> <maml:para>Gets a brief description of all server blades to which the current user has access.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerName cmdlet gets a brief description of all server blades to which the current user has access. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerName requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerName -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerName : {@{Bay=1; ServerName=ProLiant BL420c Gen8; SerialNumber=6CU4100JM2; Status=Other; Power=Off; UID=Off; Partner=}, @{Bay=2; ServerName=Absent; SerialNumber=; Status=; Power=; UID=; Partner=}, @{Bay=3; ServerName=Absent; SerialNumber=; Status=; Power=; UID=; Partner=}, @{Bay=4; ServerName=ProLiant BL660c Gen8; SerialNumber=6CU4100JMF; Status=Other; Power=On; UID=Off; Partner=}...} Total : 3 server blades installed, 1 powered on. IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerName : {@{Bay=1; ServerName=Integrity BL860c i2; SerialNumber=US23456789; Status=OK; Power=On; UID=On; Partner=}, @{Bay=2; ServerName=Absent; SerialNumber=; Status=; Power=; UID=; Partner=}, @{Bay=3; ServerName=Integrity BL860c i2; SerialNumber=US23456789; Status=OK; Power=On; UID=On; Partner=}, @{Bay=4; ServerName=ProLiant BL620c G7; SerialNumber=6CU4100JM4; Status=Degraded; Power=Off; UID=On; Partner=}...} Total : 3 server blades installed, 2 powered on. </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAServerName IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerName : {@{Bay=1; ServerName=ProLiant BL420c Gen8; SerialNumber=6CU4100JM2; Status=Other; Power=Off; UID=Off; Partner=}, @{Bay=2; ServerName=Absent; SerialNumber=; Status=; Power=; UID=; Partner=}, @{Bay=3; ServerName=Absent; SerialNumber=; Status=; Power=; UID=; Partner=}, @{Bay=4; ServerName=ProLiant BL660c Gen8; SerialNumber=6CU4100JMF; Status=Other; Power=On; UID=Off; Partner=}...} Total : 3 server blades installed, 1 powered on. IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerName : {@{Bay=1; ServerName=Integrity BL860c i2; SerialNumber=US23456789; Status=OK; Power=On; UID=On; Partner=}, @{Bay=2; ServerName=Absent; SerialNumber=; Status=; Power=; UID=; Partner=}, @{Bay=3; ServerName=Integrity BL860c i2; SerialNumber=US23456789; Status=OK; Power=On; UID=On; Partner=}, @{Bay=4; ServerName=ProLiant BL620c G7; SerialNumber=6CU4100JM4; Status=Degraded; Power=Off; UID=On; Partner=}...} Total : 3 server blades installed, 2 powered on. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerPortMap</command:name> <maml:description> <maml:para>Gets the port mapping for the server specified by the bay number.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerPortMap</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerPortMap cmdlet gets the port mapping for the server specified by the bay number. This command is not applicable to storage blades. Different sides of the server bay cannot be designated within the same range.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerPortMap</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) for server(s) for which to retrieve port mapping. Bay numbers can be specified as All|<Bay number>|<bay number>[,|-<bay number>].</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerPortMap requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerPortMap -Connection $connection -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerPortMap : {@{Bay=1; BayStatus=Present; PortMapping=No Port Mapping information available for blade 1}, @{Bay=2; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerPortMap : {@{Bay=1; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}, @{Bay=2; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with bay.</maml: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-HPEOAServerPortMap -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerPortMap : {@{Bay=1; BayStatus=Present; PortMapping=No Port Mapping information available for blade 1}, @{Bay=2; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}, @{Bay=3; BayStatus=Absent}, @{Bay=4; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerPortMap : {@{Bay=1; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}, @{Bay=2; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}, @{Bay=3; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}, @{Bay=4; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, the default value All is used.</maml: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:\> $connection | Get-HPEOAServerPortMap IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerPortMap : {@{Bay=1; BayStatus=Present; PortMapping=No Port Mapping information available for blade 1}, @{Bay=2; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}, @{Bay=3; BayStatus=Absent}, @{Bay=4; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerPortMap : {@{Bay=1; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}, @{Bay=2; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}, @{Bay=3; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}, @{Bay=4; BayStatus=Present; PortMapping=System.Management.Automation.PSObject[]}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerPowerDelay</command:name> <maml:description> <maml:para>Gets the PowerDelay status for the specified server blade or range of server blades.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerPowerDelay</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerPowerDelay cmdlet gets the PowerDelay status for the specified server blade or range of server blades. Different sides of the server bay cannot be designated within the same range. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerPowerDelay</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) for server(s) for which to retrieve power delay status. Bay numbers can be specified as All|<Bay number>|<bay number>[,|-<bay number>].</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerPowerDelay requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerPowerDelay -Connection $connection -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK PowerDelayDetail : {@{Bay=1; Device=ProLiant BL420c Gen8; PowerDelayState=Enabled; DelaySeconds=20}, @{Bay=2; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}} CurrentPowerDelayStatus : Not in Progress IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK PowerDelayDetail : {@{Bay=1; Device=Integrity BL860c i2; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=2; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}} CurrentPowerDelayStatus : Not in Progress </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with bay.</maml: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-HPEOAServerPowerDelay -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK PowerDelayDetail : {@{Bay=1; Device=ProLiant BL420c Gen8; PowerDelayState=Enabled; DelaySeconds=20}, @{Bay=1A; Device=Absent; PowerDelayState=Enabled; DelaySeconds=20}, @{Bay=1B; Device=Absent; PowerDelayState=Enabled; DelaySeconds=100}, @{Bay=2; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}...} CurrentPowerDelayStatus : Not in Progress IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK PowerDelayDetail : {@{Bay=1; Device=Integrity BL860c i2; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=1A; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=1B; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=2; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}...} CurrentPowerDelayStatus : Not in Progress </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, the default value All is used.</maml: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:\> $connection | Get-HPEOAServerPowerDelay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK PowerDelayDetail : {@{Bay=1; Device=ProLiant BL420c Gen8; PowerDelayState=Enabled; DelaySeconds=20}, @{Bay=1A; Device=Absent; PowerDelayState=Enabled; DelaySeconds=20}, @{Bay=1B; Device=Absent; PowerDelayState=Enabled; DelaySeconds=100}, @{Bay=2; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}...} CurrentPowerDelayStatus : Not in Progress IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK PowerDelayDetail : {@{Bay=1; Device=Integrity BL860c i2; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=1A; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=1B; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}, @{Bay=2; Device=Absent; PowerDelayState=Disabled; DelaySeconds=0}...} CurrentPowerDelayStatus : Not in Progress </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerStatus</command:name> <maml:description> <maml:para>Gets power, health, thermal and UID setting of the server blade.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerStatus cmdlet gets the following server blade settings: - Power (OK or off) - Health (OK, CPU failure, or power module failure) - Thermal (OK, warm, caution, or critical) - UID LED </maml:para> <maml:para>If the power management controller is outdated or is in a lockup condition, a power management controller error appears. A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) for server(s) for which to retrieve power delay status. Bay numbers can be specified as All|<Bay number>|<bay number>[,|-<bay number>].</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerStatus requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerStatus -Connection $connection -Bay $bay IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Blade : {@{Power=Off; CurrentWattageUsed=0; InternalHealth=Other; SystemHealth=OK; UnitIdentificationLED=On; VirtualFan=0%; DiagnosticStatus=; Bay=1}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Blade : {@{Power=Off; CurrentWattageUsed=0; Health=Other; UnitIdentificationLED=Off; VirtualFan=0%; DiagnosticStatus=; Bay=1}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Bay.</maml: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-HPEOAServerStatus -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Blade : {@{Power=Off; CurrentWattageUsed=0; InternalHealth=Other; SystemHealth=OK; UnitIdentificationLED=On; VirtualFan=0%; DiagnosticStatus=; Bay=1}, @{Power=No Server Blade Installed; Bay=2}, @{Power=Off; CurrentWattageUsed=0; InternalHealth=Other; SystemHealth=OK; UnitIdentificationLED=On; VirtualFan=0%; DiagnosticStatus=; Bay=3}, @{Power=Off; CurrentWattageUsed=0; Health=Degraded; UnitIdentificationLED=On; VirtualFan=0%; DiagnosticStatus=; Bay= 4}...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Blade : {@{Power=Off; CurrentWattageUsed=0; Health=Other; UnitIdentificationLED=Off; VirtualFan=0%; DiagnosticStatus=; Bay=1}, @{Power=No Server Blade Installed; Bay=2}, @{Power=No Server Blade Installed; Bay=3}, @{Power=On; CurrentWattageUsed=140; Health=Other; UnitIdentificationLED=Off; VirtualFan=22%; DiagnosticStatus=; Bay=4}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Parameter Bay is not input, so the default value ALL is used, and the information of all the bays is displayed.</maml: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:\> $server | Get-HPEOAServerStatus IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Blade : {@{Power=Off; CurrentWattageUsed=0; InternalHealth=Other; SystemHealth=OK; UnitIdentificationLED=On; VirtualFan=0%; DiagnosticStatus=; Bay=1}, @{Power=Off; CurrentWattageUsed=0; Health=Degraded; UnitIdentificationLED=On; VirtualFan=0%; DiagnosticStatus=; Bay=4}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Blade : {@{Power=Off; CurrentWattageUsed=0; Health=Other; UnitIdentificationLED=Off; VirtualFan=0%; DiagnosticStatus=; Bay=1}, @{Power=No Server Blade Installed; Bay=2}} </dev:code> <dev:remarks> <maml:para>In this example connection and bay information in $server is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAServerTemp</command:name> <maml:description> <maml:para>Gets the temperature sensor information for a specified server blade or range of server blades.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAServerTemp</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAServerTemp cmdlet gets the temperature sensor information for a specified server blade or range of server blades. Different sides of the server bay cannot be designated within the same range.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users with bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAServerTemp</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) for server(s) for which to retrieve power delay status. Bay numbers can be specified as All|<Bay number>|<bay number>[,|-<bay number>]. If bay is not specified, the default value All is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAServerTemp requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAServerTemp -Connection $connection -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerTemp : {@{Bay=1; VirtualFan=23%; TemperatureInformation=System.Management.Automation.PSObject[]}, @{Bay=2; TemperatureInformation=Blade Power is Off. Cannot retrieve data.}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerTemp : {@{Bay=1; TemperatureInformation=No Server Blade Installed}, @{Bay=2; TemperatureInformation=No Server Blade Installed}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with bay.</maml: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-HPEOAServerTemp -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerTemp : {@{Bay=1; VirtualFan=23%; TemperatureInformation=System.Management.Automation.PSObject[]}, @{Bay=2; TemperatureInformation=Blade Power is Off. Cannot retrieve data.}, @{Bay=3; TemperatureInformation=No Server Blade Installed}, @{Bay=4; VirtualFan=47%; TemperatureInformation=System.Management.Automation.PSObject[]}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerTemp : {@{Bay=1; TemperatureInformation=No Server Blade Installed}, @{Bay=2; TemperatureInformation=No Server Blade Installed}, @{Bay=3; TemperatureInformation=No Server Blade Installed}, @{Bay=4; TemperatureInformation=No Server Blade Installed}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the bay parameter is not provided, the default value All is used.</maml: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:\> $connection | Get-HPEOAServerTemp IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK ServerTemp : {@{Bay=1; VirtualFan=23%; TemperatureInformation=System.Management.Automation.PSObject[]}, @{Bay=2; TemperatureInformation=Blade Power is Off. Cannot retrieve data.}, @{Bay=3; TemperatureInformation=No Server Blade Installed}, @{Bay=4; VirtualFan=47%; TemperatureInformation=System.Management.Automation.PSObject[]}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK ServerTemp : {@{Bay=1; TemperatureInformation=No Server Blade Installed}, @{Bay=2; TemperatureInformation=No Server Blade Installed}, @{Bay=3; TemperatureInformation=No Server Blade Installed}, @{Bay=4; TemperatureInformation=No Server Blade Installed}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOASessionTimeout</command:name> <maml:description> <maml:para>Gets the current Onboard Administrator user session timeout.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASessionTimeout</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASessionTimeout cmdlet gets the current Onboard Administrator user session timeout. The session timeout is the number of minutes before inactive sessions are removed. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOASessionTimeout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOASessionTimeout requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOASessionTimeout -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK SessionTimeout : 1440 minutes IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK SessionTimeout : 1440 minutes </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOASessionTimeout IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK SessionTimeout : 1440 minutes IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK SessionTimeout : 1440 minutes </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOASNMP</command:name> <maml:description> <maml:para>Gets SNMP settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASNMP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASNMP cmdlet gets the following SNMP settings: - SNMP system name - Location - Contact - Read community name - Write community name - List of the trap destinations </maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOASNMP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOASNMP requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOASNMP -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Status : Enabled SystemName : PoseidonC3000_LowC SystemLocation : SystemContact : ReadCommunityName : WriteCommunityName : TrapReceiverHost : {xxx public, 1.1.1.2 aaa, 1.2.2.2 aaa, 2.1.1.1 aaa...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Status : Disabled SystemName : Southking SystemLocation : SystemContact : XXXX_$$$$ ReadCommunityName : WriteCommunityName : EngineID : 0x8000000b0431323334353637383930 TrapReceiverHost : </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOASNMP IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK Status : Enabled SystemName : PoseidonC3000_LowC SystemLocation : SystemContact : ReadCommunityName : WriteCommunityName : TrapReceiverHost : {xxx public, 1.1.1.2 aaa, 1.2.2.2 aaa, 2.1.1.1 aaa...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Status : Disabled SystemName : Southking SystemLocation : SystemContact : XXXX_$$$$ ReadCommunityName : WriteCommunityName : EngineID : 0x8000000b0431323334353637383930 TrapReceiverHost : </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOASNMPUser</command:name> <maml:description> <maml:para>Gets information about SNMP users.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASNMPUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASNMPUser cmdlet gets the information about SNMPv3 users. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOASNMPUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>User</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the SNMPv3 username for which the information is retrieved. Possible values are All or the specific username for which the information is to be retrieved. If All is specified as the value, then a list of all current users is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOASNMPUser requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS C:\> Get-HPEOASNMPUser -Connection $connection -User $user IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK User : test1 Local : yes Access : read-only AuthenticationProtocol : SHA-1 PrivacyProtocol : AES-128 MinimumSecurityLevel : authNoPriv EngineID : 0x8000000b045553453932344d564254 IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK User : test1 Local : no Access : none AuthenticationProtocol : MD5 PrivacyProtocol : DES MinimumSecurityLevel : none EngineID : 0x8000000b045553453932314d424a38 </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with User.</maml: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-HPEOASNMPUser -Connection $connection -user ALL IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK SNMPUser : {@{SNMPv3User=test1; Local=local; Access=ro; Security=authNoPriv; EngineID=0x8000000b045553453932344d564254}} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK SNMPUser : {@{SNMPv3User=test1; Local=remote; Access=N/A; Security=N/A; EngineID=0x8000000b045553453932314d424a38}, @{SNMPv3User=test2; Local=remote; Access=N/A; Security=N/A; EngineID=0x8000000b045553453932314d424a38}} </dev:code> <dev:remarks> <maml:para>In this example the list of Onboard Administrator connection is passed as a parameter. If parameter User value is ALL, the list of all current users is displayed.</maml: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-HPEOASNMPUser -Connection $connection User not provided... Use same User for all Connections? (y/n): y Please enter User: test1 IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK User : test1 Local : yes Access : read-only AuthenticationProtocol : SHA-1 PrivacyProtocol : AES-128 MinimumSecurityLevel : authNoPriv EngineID : 0x8000000b045553453932344d564254 IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK User : test1 Local : no Access : none AuthenticationProtocol : MD5 PrivacyProtocol : DES MinimumSecurityLevel : none EngineID : 0x8000000b045553453932314d424a38 </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter. If parameter User value is not provided, you are prompted to input the value.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOASSHFingerprint</command:name> <maml:description> <maml:para>Gets the key fingerprint of the Onboard Administrator host public key.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASSHFingerprint</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASSHFingerprint cmdlet gets the key fingerprint of the Onboard Administrator host public key. A list of connection objects must be provided as a parameter. OA administrator, OA operator, or OA user access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOASSHFingerprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOASSHFingerprint requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Get-HPEOASSHFingerprint -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK SSHFingerprint : 1024 sha1:45:68:b6:da:b1:eb:1c:8e:30:af:93:d6:a3:c3:69:fa:c9:83:af:d1 /etc/ssh/ssh_host_dsa_key.pub (DSA) IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK SSHFingerprint : 2048 sha1:94:cf:a4:a6:51:28:9c:55:61:d8:b5:c4:71:35:34:ac:9d:c3:3d:5c /etc/ssh/ssh_host_rsa_key.pub (RSA) </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter to the command line.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Get-HPEOASSHFingerprint IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK SSHFingerprint : 1024 sha1:45:68:b6:da:b1:eb:1c:8e:30:af:93:d6:a3:c3:69:fa:c9:83:af:d1 /etc/ssh/ssh_host_dsa_key.pub (DSA) IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK SSHFingerprint : 2048 sha1:94:cf:a4:a6:51:28:9c:55:61:d8:b5:c4:71:35:34:ac:9d:c3:3d:5c /etc/ssh/ssh_host_rsa_key.pub (RSA) </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOASSHKey</command:name> <maml:description> <maml:para>Gets the contents of the existing SSH authorized key files.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASSHKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASSHKey cmdlet gets the contents of the existing SSH authorized key files. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOASSHKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOASSHKey requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Get-HPEOASSHKey -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK SSHKEY : {southking.company.net ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC5coYVxLCU3QR5jkbQUDDH+cDwON0UIzi7gmR3chDGyIk+pcmz6XltbHihKGlMywmjbN5cAs7RNObEnUCHtm0Wt6IyZtW9k8a89uALeW PrqV9nlXu/A1eIhX25TGKQ6hjF+L4YdUgRuPIR8/+01S3/uy65oiT0QvjZG8pnOjIuXIVZYqe+TFabpjFHzqzG7FBmYYsbf5OGwY9vEX5pt+3cTzjMsq8yItwEyhtqp67hSPTsvF/TZMFvNS9X+YPxyp67zt8/LxNa+z hAMmFlFLx00S9mto5MJMoNQrbbZtYpOIazm+wiE7c6S8xtcCqmCZpnAfT9mPwHq3eGCKqwHJjf, 192.168.244.108 ssh-dss AAAAB3NzaC1kc3MAAACBAMcIYfyqwcdUbfXQ8P3VNfGYiCHI7qVqwSWL+6I+12gbe ZJkxtPFXDOApcIchXPBUeZr5H8wamSnHilEDa6qRDid7J9fmwTMQ3mDDtE5Vo7kI+/dFtm04h38jp9ZIXLMyUFYtZBAbD2zyeq87gmc4QMAJ05umbyAu0LU6ugqc+JXAAAAFQCUkO7ZcgC4wSUkDfbeH8RMf4TlPQAAA IBExzhxANQOh6y3eMD7J9Hl0Of6vQDgoPFEBZhDwM7flAdwZvfjC7lQpcJcbo83AKJKV20XyeNCo36dvqVoF7sEMyIMc} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : There is no SSH key installed. </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter to the command line.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Get-HPEOASSHKey IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK SSHKEY : {southking.company.net ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC5coYVxLCU3QR5jkbQUDDH+cDwON0UIzi7gmR3chDGyIk+pcmz6XltbHihKGlMywmjbN5cAs7RNObEnUCHtm0Wt6IyZtW9k8a89uALeW PrqV9nlXu/A1eIhX25TGKQ6hjF+L4YdUgRuPIR8/+01S3/uy65oiT0QvjZG8pnOjIuXIVZYqe+TFabpjFHzqzG7FBmYYsbf5OGwY9vEX5pt+3cTzjMsq8yItwEyhtqp67hSPTsvF/TZMFvNS9X+YPxyp67zt8/LxNa+z hAMmFlFLx00S9mto5MJMoNQrbbZtYpOIazm+wiE7c6S8xtcCqmCZpnAfT9mPwHq3eGCKqwHJjf, 192.168.244.108 ssh-dss AAAAB3NzaC1kc3MAAACBAMcIYfyqwcdUbfXQ8P3VNfGYiCHI7qVqwSWL+6I+12gbe ZJkxtPFXDOApcIchXPBUeZr5H8wamSnHilEDa6qRDid7J9fmwTMQ3mDDtE5Vo7kI+/dFtm04h38jp9ZIXLMyUFYtZBAbD2zyeq87gmc4QMAJ05umbyAu0LU6ugqc+JXAAAAFQCUkO7ZcgC4wSUkDfbeH8RMf4TlPQAAA IBExzhxANQOh6y3eMD7J9Hl0Of6vQDgoPFEBZhDwM7flAdwZvfjC7lQpcJcbo83AKJKV20XyeNCo36dvqVoF7sEMyIMc} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : There is no SSH key installed. </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAStatus</command:name> <maml:description> <maml:para>Gets health status for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAStatus cdmlet gets health status for the Onboard Administrator. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="bayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the OA for which health status will be retrieved. The values can be: All | <bay number> [{ , | - } <bay number>] | Active | Standby]. If you do not specify the Bay, the command defaults to the Active Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Active</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAStatus requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAStatus -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{Name=eastwind; Role=Active; UID=Off; Status=OK; Bay=2}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{Name=OA-002264345175; Role=Active; UID=Off; Status=OK; DiagnosticStatus=; Bay=2}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Parameter Bay is not input, so the default value is Active and the information of the Active Onboard Administrator is displayed.</maml: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:\> $connection |Get-HPEOAStatus -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{Name=westwind; Role=Active; UID=Off; Status=OK; DiagnosticStatus=; Bay=1}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{Name=northwind; Role=Active; UID=Off; Status=OK; DiagnosticStatus=; Bay=1}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOASyslog</command:name> <maml:description> <maml:para>Gets the syslog for the Onboard Administrator, for the specified server blade, enclosure or iLO.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASyslog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASyslog cmdlet gets the syslog for the Onboard Administrator, for the specified server blade, enclosure or iLO. A list of connection objects must be provided as a parameter. OA administrator, OA operator, or OA user access are required to execute this cmdlet for viewing OA logs. Server, Enclosure, and iLO logs can be viewed by all users having access to the specified bay.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOASyslog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the device(s) for which the syslog have to be retrieved. Possible values are OA, iLO, Enclosure and Server. If the value is set to Enclosure, the value for Bay parameter is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the OA for which Syslog has to be retrieved. If no bay number is given, then the Active Onboard Administrator syslog appears. The value is specified as <bay number>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOASyslog requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOASysLog -Connection $connection -Target ILO IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Bay : {@{iLOEventLog=Request is valid only for ProLiant SERVER blades.; BayNumber=1}, @{iLOEventLog=Request is valid only for ProLiant SERVER blades.; BayNumber=2}, @{iLOEventLog=Request is valid only for ProLiant SERVER blades.; BayNumber=3}, @{iLOEventLog=System.Collections.Generic.List`1[System.Management.Automation.PSObject]; BayNumber=4}...} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK Bay : {@{iLOEventLog=The blade is not present.; BayNumber=1}, @{iLOEventLog=The blade is not present.; BayNumber=2}, @{iLOEventLog=The blade is not present.; BayNumber=3}, @{iLOEventLog=The blade is not present.; BayNumber=4}...} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Target,bay.</maml: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-HPEOASysLog -Connection $connection Target not provided... Use same Target for all Connections? (y/n): y Please enter Target: ILO IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Bay : {@{iLOEventLog=Request is valid only for ProLiant SERVER blades.; BayNumber=1}, @{iLOEventLog=Request is valid only for ProLiant SERVER blades.; BayNumber=2}, @{iLOEventLog=Request is valid only for ProLiant SERVER blades.; BayNumber=3}, @{iLOEventLog=System.Collections.Generic.List`1[System.Management.Automation.PSObject]; BayNumber=4}...} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK Bay : {@{iLOEventLog=The blade is not present.; BayNumber=1}, @{iLOEventLog=The blade is not present.; BayNumber=2}, @{iLOEventLog=The blade is not present.; BayNumber=3}, @{iLOEventLog=The blade is not present.; BayNumber=4}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Target parameter is not provided, you are prompted to input the values.</maml: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:\> $connection | Get-HPEOASysLog -Target ILO IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Bay : {@{iLOEventLog=Request is valid only for ProLiant SERVER blades.; BayNumber=1}, @{iLOEventLog=Request is valid only for ProLiant SERVER blades.; BayNumber=2}, @{iLOEventLog=Request is valid only for ProLiant SERVER blades.; BayNumber=3}, @{iLOEventLog=System.Collections.Generic.List`1[System.Management.Automation.PSObject]; BayNumber=4}...} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK Bay : {@{iLOEventLog=The blade is not present.; BayNumber=1}, @{iLOEventLog=The blade is not present.; BayNumber=2}, @{iLOEventLog=The blade is not present.; BayNumber=3}, @{iLOEventLog=The blade is not present.; BayNumber=4}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOASyslogHistory</command:name> <maml:description> <maml:para>Gets the extended system log history for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASyslogHistory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASyslogHistory cmdlet gets the extended system log history for the Onboard Administrator. The extended system log appears for the Active Onboard Administrator. A list of connection objects must be provided as a parameter. OA administrator, OA operator, or OA user access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOASyslogHistory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Count</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of log entries to be retrieved. Use 0 to display all logged entries.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOASyslogHistory requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOASyslogHistory -Connection $connection -Count 5 IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Log : {@{Time=Nov 14 06:51:04; Message= OA Log cleared by Administrator. }, @{Time=Nov 14 06:51:04; Message= OA Factory defaults restored by Administrator}, @{Time=Nov 14 06:51:12; Message= OA Onboard Administrator is rebooting}, @{Time=Nov 14 07:52:08; Message= Cert OA Generated new 2048 Bit SSH RSA Key and Fingerprint}...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Log : {@{Time=May 11 22:52:34; Message= OA Log cleared by Administrator. }, @{Time=May 11 22:54:38; Message= OA Administrator logged into the Onboard Administrator from 192.168.243.152}, @{Time=May 11 22:54:38; Message= OA Administrator logged out of the Onboard Administrator}, @{Time=May 11 22:54:39; Message= OA Administrator logged out of the Onboard Administrator}...} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Count.</maml: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:\> $connection | Get-HPEOASyslogHistory -Count 5 IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK Log : {@{Time=Nov 14 06:51:04; Message= OA Log cleared by Administrator. }, @{Time=Nov 14 06:51:04; Message= OA Factory defaults restored by Administrator}, @{Time=Nov 14 06:51:12; Message= OA Onboard Administrator is rebooting}, @{Time=Nov 14 07:52:08; Message= Cert OA Generated new 2048 Bit SSH RSA Key and Fingerprint}...} IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK Log : {@{Time=May 11 22:52:34; Message= OA Log cleared by Administrator. }, @{Time=May 11 22:54:38; Message= OA Administrator logged into the Onboard Administrator from 192.168.243.152}, @{Time=May 11 22:54:38; Message= OA Administrator logged out of the Onboard Administrator}, @{Time=May 11 22:54:39; Message= OA Administrator logged out of the Onboard Administrator}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOASyslogSetting</command:name> <maml:description> <maml:para>Gets the remote syslog settings for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASyslogSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASyslogSetting cmdlet gets the remote syslog settings for the Onboard Administrator. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOASyslogSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOASyslogSetting requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOASyslogSetting -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK RemoteLog : Disabled Address : Port : 514 IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK RemoteLog : Disabled Address : 123456.xxx.cm Port : 56566 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection | Get-HPEOASyslogSetting IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK RemoteLog : Disabled Address : Port : 514 IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK RemoteLog : Disabled Address : 123456.xxx.cm Port : 56566 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOATopology</command:name> <maml:description> <maml:para>Gets the enclosures connected by the enclosure link.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOATopology</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOATopology cmdlet gets the enclosures connected by the enclosure link. It also gets a table with the enclosure name, UUID, Enclosure Rack U Position, overall health of the enclosure, and the IP address. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOATopology</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOATopology requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOATopology -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK RackTopology : top-down RackUUID : 09USE921MBJ8 RackName : Rack12 LinkedEnclosureInfo : {@{EnclosureName=PoseidonC7000_MidC; Status=Degraded; Local=Yes; IPAddress=192.168.242.63; UUID=09USE921MBJ8}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK RackTopology : top-down RackUUID : 09USE924MVBT RackName : southking LinkedEnclosureInfo : {@{EnclosureName=Southking; Status=Degraded; Local=Yes; IPAddress=192.168.242.64; UUID=09USE924MVBT}} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOATopology IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK RackTopology : top-down RackUUID : 09USE921MBJ8 RackName : Rack12 LinkedEnclosureInfo : {@{EnclosureName=PoseidonC7000_MidC; Status=Degraded; Local=Yes; IPAddress=192.168.242.63; UUID=09USE921MBJ8}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK RackTopology : top-down RackUUID : 09USE924MVBT RackName : southking LinkedEnclosureInfo : {@{EnclosureName=Southking; Status=Degraded; Local=Yes; IPAddress=192.168.242.64; UUID=09USE924MVBT}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOATwoFactorInfo</command:name> <maml:description> <maml:para>Gets the configuration details for Two-Factor Authentication.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOATwoFactorInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOATwoFactorInfo cmdlet gets the configuration details for Two-Factor Authentication. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOATwoFactorInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOATwoFactorInfo requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Get-HPEOATwoFactorInfo -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK TwoFactorAuthentication : Disabled CertificateRevocation : Disabled CertificateOwnerField : Subject IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK TwoFactorAuthentication : Disabled CertificateRevocation : Disabled CertificateOwnerField : Subject </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter to the command line.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Get-HPEOATwoFactorInfo IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK TwoFactorAuthentication : Disabled CertificateRevocation : Disabled CertificateOwnerField : Subject IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK TwoFactorAuthentication : Disabled CertificateRevocation : Disabled CertificateOwnerField : Subject </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAUpgradableDevice</command:name> <maml:description> <maml:para>Gets enclosure devices that are available for firmware upgrade.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAUpgradableDevice</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAUpgradableDevice cmdlet gets enclosure devices that are available for firmware upgrade. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAUpgradableDevice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAUpgradableDevice requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAUpgradableDevice -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK UpgradableDevice : {@{Device=TRAY; Name=BladeSystem c7000 Onboard Administrator Tray; Location=; Version=1.7; NewVersion=1.7}, @{Device=LCD; Name=BladeSystem c7000 Insight Display; Location=; Version=2.2.2; NewVersion=2.2.2}, @{Device=FAN; Name=Active Cool 200 Fan; Location=1; Version=2.7.4; NewVersion=2.7.4}, @{Device=FAN; Name=Active Cool 200 Fan; Location=2; Version=2.7.4; NewVersion=2.7.4}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK UpgradableDevice : {@{Device=TRAY; Name=c3000 Tray with embedded DDR2 Onboard Adminis; Location=; Version=2.10; NewVersion=2.10}, @{Device=LCD; Name=BladeSystem c3000 Insight Display; Location=; Version=2.4.3; NewVersion=2.4.3}, @{Device=FAN; Name=Active Cool 200 Fan; Location=1; Version=2.7.4; NewVersion=2.7.4}, @{Device=FAN; Name=Active Cool 200 Fan; Location=2; Version=2.7.4; NewVersion=2.7.4}...} </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAUpgradableDevice IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK UpgradableDevice : {@{Device=TRAY; Name=BladeSystem c7000 Onboard Administrator Tray; Location=; Version=1.7; NewVersion=1.7}, @{Device=LCD; Name=BladeSystem c7000 Insight Display; Location=; Version=2.2.2; NewVersion=2.2.2}, @{Device=FAN; Name=Active Cool 200 Fan; Location=1; Version=2.7.4; NewVersion=2.7.4}, @{Device=FAN; Name=Active Cool 200 Fan; Location=2; Version=2.7.4; NewVersion=2.7.4}...} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK UpgradableDevice : {@{Device=TRAY; Name=c3000 Tray with embedded DDR2 Onboard Adminis; Location=; Version=2.10; NewVersion=2.10}, @{Device=LCD; Name=BladeSystem c3000 Insight Display; Location=; Version=2.4.3; NewVersion=2.4.3}, @{Device=FAN; Name=Active Cool 200 Fan; Location=1; Version=2.7.4; NewVersion=2.7.4}, @{Device=FAN; Name=Active Cool 200 Fan; Location=2; Version=2.7.4; NewVersion=2.7.4}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAUpTime</command:name> <maml:description> <maml:para>Gets uptime for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAUpTime</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAUpTime cmdlet gets uptime for the Onboard Administrator. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAUpTime</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Can be specified as [All | <bay number> [{ , | - } <bay number>] | Active | Standby]]. If you do not specify the Onboard Administrator, the command defaults to the Onboard Administrator where the cmdlet is being run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAUpTime requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAUpTime -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{Role=Active; Uptime=7 days, 18 hours, 5 min; CPULoad=3.63, 2.85, 2.56; Bay=1}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{Role=Active; Uptime=15 days, 1 hours, 17 min; CPULoad=0.24, 0.25, 0.21; Bay= 1}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the parameter Bay is not specified, the default value is Active and the information of the active Onboard Administrator is displayed.</maml: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:\> $connection | Get-HPEOAUpTime -Bay $bay IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{Role=Active; Uptime=7 days, 18 hours, 8 min; CPULoad=2.10, 2.27, 2.36; Bay=1}} IP : 192.168.241.254 Hostname : northwind.company.net StatusType : OK StatusMessage : OK OnboardAdministrator : {@{Role=Active; Uptime=15 days, 1 hours, 20 min; CPULoad=0.12, 0.19, 0.19; Bay=1}} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAURB</command:name> <maml:description> <maml:para>Gets the URB reporting settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAURB</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAURB cmdlet gets the URB reporting settings. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAURB</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAURB requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Get-HPEOAURB -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK URBReporting : Disabled EndpointURL : ProxyURL : SMTPServer : EmailAddress : Interval : Daily at hour 0 LastAttempt : {} B</dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Get-HPEOAURB IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK URBReporting : Disabled EndpointURL : ProxyURL : SMTPServer : EmailAddress : Interval : Daily at hour 0 LastAttempt : {} </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAUSB</command:name> <maml:description> <maml:para>Gets which USB controller is currently enabled.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAUSB</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAUSB cmdlet gets which USB controller is currently enabled. The FRONT controller enables the internal DVD drive and the front USB connector. The BACK controller enables the two USB ports on the near KVM Option Module.</maml:para> <maml:para>The Get-HPEOAUSB cmdlet has no effect on HP c3000 OA boards that are hardware revision level C0 and later. Hardware revision is determined using the Get-HPEOAInfo command. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAUSB</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAUSB requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAUSB -Connection $connection IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.242.63 westwind.company.net OK USB setting not supported on OA in this e... 192.168.242.64 southwind.company.net OK USB setting not supported on OA in this e... </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAUSB IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.242.63 westwind.company.net OK USB setting not supported on OA in this e... 192.168.242.64 southwind.company.net OK USB setting not supported on OA in this e... </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAUSBKey</command:name> <maml:description> <maml:para>Gets a list of Firmware images, configuration scripts, and ISO images present on the enclosure USB media.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAUSBKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAUSBKey cmdlet gets a list of Firmware images, configuration scripts, and ISO images present on the enclosure USB media. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAUSBKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAUSBKey requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAUSBKey -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : ConfigurationScriptFiles: No configuration files found (*.cfg). FirmwareImageFiles : {@{FileName=usb://d1/HPEOA420.bin; ImageVersion=4.20}} OtherBinaryFiles : {@{FileName=usb://d1/ilo3_fw_bin_170.bin}, @{FileName=usb://d1/ilo4_140.bin}, @{FileName=usb://d1/ilo4_150.bin}} ISOImageFiles : {@{FileName=usb://d1/fw930.iso}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : No USB keys detected in this Onboard Administrator. Note: USB keys can only be used in the Active Onboard Administrator. </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAUSBKey IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : ConfigurationScriptFiles: No configuration files found (*.cfg). FirmwareImageFiles : {@{FileName=usb://d1/HPEOA420.bin; ImageVersion=4.20}} OtherBinaryFiles : {@{FileName=usb://d1/ilo3_fw_bin_170.bin}, @{FileName=usb://d1/ilo4_140.bin}, @{FileName=usb://d1/ilo4_150.bin}} ISOImageFiles : {@{FileName=usb://d1/fw930.iso}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : No USB keys detected in this Onboard Administrator. Note: USB keys can only be used in the Active Onboard Administrator. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAUser</command:name> <maml:description> <maml:para>Gets details for the specified user.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAUser cmdlet gets the user's full name, contact information, access rights, account status, and bays that the user can access. Users who do not have OA administrator access levels can only view their user information.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>The user name for which the details will be retrieved. The values can be All or a specific user name. If you enter All and are an OA administrator, the information for every user is listed. If a user name or All is not entered, information for the current user is displayed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAUser requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAUser -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK FullName : System Administrator ContactInfo : UserRights : Admin AccountStatus : Enabled ServerBayAccessList : 1 1A 1B 2 2A 2B 3 3A 3B 4 4A 4B 5 5A 5B 6 6A 6B 7 7A 7B 8 8A 8B InterconnectBayAccessList : 1 2 3 4 OAAccess : Yes UserName : Administrator IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK FullName : System Administrator ContactInfo : System Administrator UserRights : Admin AccountStatus : Enabled ServerBayAccessList : 1 1A 1B 2 2A 2B 3 3A 3B 4 4A 4B 5 5A 5B 6 6A 6B 7 7A 7B 8 8A 8B InterconnectBayAccessList : 1 2 3 4 OAAccess : Yes UserName : Administrator </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the parameter Username is not input, the default value is the current user and information for the current user is displayed.</maml: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:\> $connection | Get-HPEOAUser -Username $username IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK FullName : System Administrator ContactInfo : UserRights : Admin AccountStatus : Enabled ServerBayAccessList : 1 1A 1B 2 2A 2B 3 3A 3B 4 4A 4B 5 5A 5B 6 6A 6B 7 7A 7B 8 8A 8B InterconnectBayAccessList : 1 2 3 4 OAAccess : Yes UserName : Administrator IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK FullName : System Administrator ContactInfo : System Administrator UserRights : Admin AccountStatus : Enabled ServerBayAccessList : 1 1A 1B 2 2A 2B 3 3A 3B 4 4A 4B 5 5A 5B 6 6A 6B 7 7A 7B 8 8A 8B InterconnectBayAccessList : 1 2 3 4 OAAccess : Yes UserName : Administrator </dev:code> <dev:remarks> <maml:para>In this example$connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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-HPEOAUser -Connection $connection -Username ALL IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : OK StatusMessage : OK UserList : {@{UserName=Admin; FullName=; PrivilegeLevel=Admin; AcctStatus=Enabled}, @{UserName=Administrator(CurrentUser); FullName=System Administrator; PrivilegeLevel=Admin; AcctStatus=Enabled}, @{UserName=Operator; FullName=; PrivilegeLevel=Operator; AcctStatus=Enabled}, @{UserName=User; FullName=; PrivilegeLevel=User; AcctStatus=Enabled}} IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK UserList : {@{UserName=Admin; FullName=; PrivilegeLevel=Admin; AcctStatus=Enabled}, @{UserName=Administrator(CurrentUser); FullName=System Administrator; PrivilegeLevel=Admin; AcctStatus=Enabled}, @{UserName=ben; FullName=; PrivilegeLevel=User; AcctStatus=Enabled}, @{UserName=nicole; FullName=; PrivilegeLevel=User; AcctStatus=Enabled}...} </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the parameter Username value is ALL, the information for every user is listed.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAVCMode</command:name> <maml:description> <maml:para>Gets Virtual Connect Mode settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAVCMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAVCMode cmdlet gets Virtual Connect Mode settings. A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAVCMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAVCMode requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAVCMode -Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK VirtualConnectMode : Disabled IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK VirtualConnectMode : Enabled VirtualConnectDomainName : PoseidonC7000_MidC_vc_domain VirtualConnectURLs : http://192.168.244.127/ (Default) </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection | Get-HPEOAVCMode IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK VirtualConnectMode : Disabled IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK VirtualConnectMode : Enabled VirtualConnectDomainName : PoseidonC7000_MidC_vc_domain VirtualConnectURLs : http://192.168.244.127/ (Default) </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HPEOAVLAN</command:name> <maml:description> <maml:para>Gets VLAN settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAVLAN</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAVLAN cmdlet gets VLAN settings. A list of connection objects must be provided as a parameter. OA administrator, OA operator, or OA user access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPEOAVLAN</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAVLAN requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with OA data is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEOAVLAN -Connection $connection IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK VlanList : {@{VLAN=1; VLANNAME=Default}, @{VLAN=2; VLANNAME=Test_Vlan}} DeviceSettings : {@{BAY=1; VLAN=1}, @{BAY=2; VLAN=2}, @{BAY=3; VLAN=1}, @{BAY=4; VLAN=1}...} InterconnectSettings : {@{BAY=1; VLAN=1}, @{BAY=2; VLAN=1}, @{BAY=3; VLAN=2}, @{BAY=4; VLAN=1}...} Summary : VLAN is enabled. OA VLAN ID = 1. Default VLAN ID (untagged) = 1. IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK VlanList : {@{VLAN=1; VLANNAME=Default}, @{VLAN=4; VLANNAME=}, @{VLAN=5; VLANNAME=4}} DeviceSettings : {@{BAY=1; VLAN=1}, @{BAY=2; VLAN=1}, @{BAY=3; VLAN=1}, @{BAY=4; VLAN=1}...} InterconnectSettings : {@{BAY=1; VLAN=1}, @{BAY=2; VLAN=1}, @{BAY=3; VLAN=1}, @{BAY=4; VLAN=1}} Summary : VLAN is enabled. OA VLAN ID = 1. Default VLAN ID (untagged) = 1. </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $connection | Get-HPEOAVLAN IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK VlanList : {@{VLAN=1; VLANNAME=Default}, @{VLAN=2; VLANNAME=Test_Vlan}} DeviceSettings : {@{BAY=1; VLAN=1}, @{BAY=2; VLAN=2}, @{BAY=3; VLAN=1}, @{BAY=4; VLAN=1}...} InterconnectSettings : {@{BAY=1; VLAN=1}, @{BAY=2; VLAN=1}, @{BAY=3; VLAN=2}, @{BAY=4; VLAN=1}...} Summary : VLAN is enabled. OA VLAN ID = 1. Default VLAN ID (untagged) = 1. IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK VlanList : {@{VLAN=1; VLANNAME=Default}, @{VLAN=4; VLANNAME=}, @{VLAN=5; VLANNAME=4}} DeviceSettings : {@{BAY=1; VLAN=1}, @{BAY=2; VLAN=1}, @{BAY=3; VLAN=1}, @{BAY=4; VLAN=1}...} InterconnectSettings : {@{BAY=1; VLAN=1}, @{BAY=2; VLAN=1}, @{BAY=3; VLAN=1}, @{BAY=4; VLAN=1}} Summary : VLAN is enabled. OA VLAN ID = 1. Default VLAN ID (untagged) = 1. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-HPEOAiLOCommand</command:name> <maml:description> <maml:para>Execution iLO command through the OA.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>HPEOAiLOCommand</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-HPEOAiLOCommand cmdlet executes iLO command through the OA. This cmdlet is designed to work with HPiLOCmdlets 1.2 or later. The uses the OA’s HPONCFG command to send a RIBCL text command through to the OA. It then sends and implements the command to the iLO returning back either a Powershell Object or the raw text RIBCL Output from running the command. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-HPEOAiLOCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>iLOCommand</maml:name> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>iLOCommand</maml:name> <maml:description> <maml:para>String, RIBCL Text only are generated by an iLO Command, there are no external files. This includes extra parameters at the beginning of the String separated by new lines which are used for conversion from RIBCL to PSObject. These extra lines of information are located before the RIBCL text and must be removed on the OA side before sending the RIBCL command. Use cmdlets in HPiLOCmdlets 1.2 or later with ExternalCommand to generate input for this parameter.</maml:para> </maml:description> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Integer indicating Bay # (a mandatory parameter).</maml:para> </maml:description> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>SSH Connection to the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Get-HPEOAVLAN requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>The Connection parameter can still be taken from pipeline or command line, while the RIBCL text from the iLO cmdlet has to be stored in a variable and passed through command line as a parameter to this cmdlet. When the output type is PSObject, the IP/Hostname of OA is listed in the output. It’s not the IP/Hostname for iLO.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $d = Get-HPiLODefaultLanguage -Server 192.168.242.160 -Username Administrator –Password XXX –OutputType ExternalCommand PS C:\> Invoke-HPEOAiLOCommand –connection $connection –iLOCommand $d –Bay 2 Bay : 2 IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK LANG_ID : en LANGUAGE : English Bay : 2 IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK V LANG_ID : en LANGUAGE : English . </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter.</maml: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:\> $d = Get-HPiLODefaultLanguage -Server 192.168.242.160 -Username Administrator –Password XXX –OutputType ExternalCommand PS C:\> $connection | Invoke-HPEOAiLOCommand –iLOCommand $d –Bay 2 Bay : 2 IP : 192.168.242.63 Hostname : westwind.company.net StatusType : OK StatusMessage : OK LANG_ID : en LANGUAGE : English Bay : 2 IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : OK V LANG_ID : en LANGUAGE : English </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOACertificate</command:name> <maml:description> <maml:para>Removes the specified trust certificate (CA, HPSIM, LDAP, RemoteSupport, User).</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOACertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOACertificate cmdlet removes the specified trust certificate (CA, HPSIM, LDAP, RemoteSupport, User). If CA certificate is removed, any users having their certificates issued by this CA can no longer login if Two-Factor Authentication is enabled.</maml:para> <maml:para>If HPSIM certificate is removed, it disables HP SIM SSO through the application (for example HP SIM) that provided the certificate without disabling other HP SIM applications. The HPSIM certificate name can be obtained using the Get-HPEOAHPSIMInfo command.</maml:para> <maml:para>Selecting type as LDAP removes the trust certificate corresponding to the MD5 certificate name. This command revokes trust in the LDAP server associated with the certificate.</maml:para> <maml:para>Selecting type as RemoteSupport removes the Remote Support trust certificate corresponding to the SHA1 certificate name.</maml:para> <maml:para>Selecting type as User removes the certificate associated with a user. If Two-Factor Authentication is enabled, this user no longer has access through HTTPS.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOACertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Certificate</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of certificate to remove. Valid Values are CA, HPSIM, LDAP, RemoteSupport, and User.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Certificate</maml:name> <maml:description> <maml:para>The name of the certificate to be removed. Possible values are SHA1 Fingerprint (CA, RemoteSupport), certificate name obtained using the Get-HPEOAHPSIMInfo command (HPSIM), and MD5 Fingerprint (LDAP). If Type is not specified to User, then the value of this parameter is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>The username for which the certificates are being removed. The Username is case sensitive. If Type is specified to User, then the value of this parameter is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOACertificate requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOACertificate -Connection $connection -Type CA -Certificate 7A:3A:8E:04:D7:B8:1D:32:4E:D9:FD:95:38:27:71:98:8B:3D:9A:21 </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Type and Certificate.</maml: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:\> Remove-HPEOACertificate -Connection $connection Type not provided... Use same Type for all Connections? (y/n): y Please enter Type (Acceptable values are User, HPSIM, CA, RemoteSupport, LDAP): CA Certificate not provided... Use same Certificate for all Connections? (y/n): n Please enter Certificate for 192.168.241.254: 7A:3A:8E:04:D7:B8:1D:32:4E:D9:FD:95:38:27:71:98:8B:3D:9A:22 Please enter Certificate for 192.168.242.64: 7A:3A:8E:04:D7:B8:1D:32:4E:D9:FD:95:38:27:71:98:8B:3D:9A:23 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Type and Certificate are not provided, you are prompted to input the values.</maml: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:\> $connection | Remove-HPEOACertificate -Type CA –Certificate 7A:3A:8E:04:D7:B8:1D:32:4E:D9:FD:95:38:27:71:98:8B:3D:9A:21 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOADNS</command:name> <maml:description> <maml:para>Removes the IP address of a DNS server from the list for the specified Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOADNS</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOADNS cmdlet removes the IP address of a DNS server from the list for the specified Onboard Administrator. The DNS servers are used only if the system is configured to use a static IP address. If no bay number is provided, the command default to the active Onboard Administrator.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOADNS</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the Onboard Administrator for which the DNS is to be removed. The bay number can be specified as <bay number>. If Bay is not specified, the default value Active is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Active</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>IP address of the DNS to be removed from the Onboard Administrator. If IPv4 is used, it must be in the form ###.###.###.###, where each ### ranges from 0 to 255. </maml:para> <maml:para>If IPv6 is used, it must be in the form ####:####:####:####:####:####:####:#### or ####:####:####:####:####:####:####:####/### (with a prefix), where each #### ranges from 0 to FFFF and the prefix /### ranges from 0 to 128. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOADNS requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOADNS -Connection $connection -IP fe80::444:64ff:fe34:5175/64 -Bay active</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with IP and Bay.</maml: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:\> Remove-HPEOADNS -Connection $connection IP not provided... Use same IP for all Connections? (y/n): n Please enter IP for 192.168.241.254: fe80::444:64ff:fe34:5175/64 Please enter IP for 192.168.242.64: 15.15.15.15 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the IP parameter is not provided, you are prompted to input the values. If the Bay parameter is not provided, the command defaults to the active Onboard Administrator.</maml: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:\> $connection | Remove-HPEOADNS -IP fe80::444:64ff:fe34:5175/64</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOAEBIPA</command:name> <maml:description> <maml:para>Removes the DNS server specified by the IP address from the list of DNS servers for either SERVER bays or INTERCONNECT bays.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOAEBIPA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOAEBIPA cmdlet removes the DNS server specified by the IP address from the list of DNS servers for either SERVER bays or INTERCONNECT bays. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOAEBIPA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target device for which the DNS entry has to be removed. Possible values are Server and Interconnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the target device for which the DNS entry has to be removed. The bay number(s) can be specified as All or <bay number>[,|- <bay number>]. The default value All is used if bay is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address of the DNS server to be removed from the target device's DNS list. IPv4 must be in the form ###.###.###.###, where each ## ranges from 0 to 255. IPv6 must be in the form ####:####:####:####:####:####:####:####/###, where #### ranges from 0 to FFFF. A compressed version of the same IPv6 address is also supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOAEBIPA requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOAEBIPA -Connection $connection -Target interconnect -IP fe80::333:64ff:fe34:5175 -Bay 1-3</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Target, IP, and Bay.</maml: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:\> Remove-HPEOAEBIPA -Connection $connection Target not provided... Use same Target for all Connections? (y/n): y Please enter Target (Acceptable values are Server, Interconnect): Server IP not provided... Use same IP for all Connections? (y/n): n Please enter IP for 192.168.241.254: fe80::444:64ff:fe34:5175 Please enter IP for 192.168.242.64: 15.15.15.15 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Target and IP are not provided, you are prompted to input the values. If the Bay parameter is not provided, the default is all servers or interconnects.</maml: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:\> $connection | Remove-HPEOAEBIPA -Target interconnect -IP fe80::333:64ff:fe34:5175</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOAIPv6Address</command:name> <maml:description> <maml:para>Removes the IPv6 static address for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOAIPv6Address</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOAIPv6Address cmdlet removes the IPv6 static address for the Onboard Administrator. If IPv6 is enabled, then this command takes effect immediately. If no Onboard Administrator number is provided, the command defaults to the active Onboard Administrator.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOAIPv6Address</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the onboard administrator for which the IPv6 address is to be removed. The bay number is specified as <bay number>. The default value Active is used if bay is not specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Active</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>The prefix length is mandatory. The IP value must be in the form ####:####:####:####:####:####:####:####/###, where each #### ranges from 0 to FFFF and the prefix /### ranges from 0 to 128.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOAIPv6Address requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOAIPv6Address -Connection $connection -IP fe80::555:64ff:fe34:5175/64 -Bay active</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with IP and Bay.</maml: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:\> Remove-HPEOAIPv6Address -Connection $connection IP not provided... Use same IP for all Connections? (y/n): n Please enter IP for 192.168.241.254: fe80::555:64ff:fe34:5175/63 Please enter IP for 192.168.242.64: fe80::555:64ff:fe34:5176/64 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the IP parameter is not provided, you are prompted to input the value. If the Bay parameter is not provided, the command defaults to the active Onboard Administrator.</maml: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:\> $connection | Remove-HPEOAIPv6Address -IP fe80::555:64ff:fe34:5175/64</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOALanguage</command:name> <maml:description> <maml:para>Removes the user specified language.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOALanguage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOALanguage cmdlet removes the user specified language. To view a list of installed language packs, use the Get-HPEOALanguage cmdlet.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOALanguage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>LanguageName</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>LanguageCode</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>LanguageName</maml:name> <maml:description> <maml:para>Specifies the name of the language pack to be removed. For example, English, Chinese, Japanese Either LanguageName or LanguageCode parameter is needed. If both LanguageName and LanguageCode are specified, only LanguageName parameter is used. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>LanguageCode</maml:name> <maml:description> <maml:para>Specifies the two letter language code of the language pack. For example, EN-English, JA-Japanese, ZH-Chinese. Either LanguageName or LanguageCode parameter is needed. If both LanguageName and LanguageCode are specified, only LanguageName parameter is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOALanguage requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOALanguage -Connection $connection -LanguageName Chinese</dev:code> <dev:remarks> <maml:para>This example removes a language pack using language name.</maml: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:\> Remove-HPEOALanguage -Connection $connection -LanguageCode zh</dev:code> <dev:remarks> <maml:para>The example removes a language pack using language code.</maml: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:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "LanguageName"="Chinese" } PS C:\> $p | Remove-HPEOALanguage </dev:code> <dev:remarks> <maml:para>This example removes a language pack in pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOALDAPBay</command:name> <maml:description> <maml:para>Disables access to the bays for the group specified.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOALDAPBay</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOALDAPBay cmdlet disables access to the bays for the group specified. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOALDAPBay</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Group</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target device for which access is to be disabled from the LDAP group. Possible values are Server and Interconnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of device(s) for which access is to be revoked from the LDAP group. The bay number can be specified as <Bay number>, All or <bay number>-<bay number>.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>LDAP group name for which access to the specified bay is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOALDAPBay requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOALDAPBay -Connection $connection -Target Interconnect -Bay 1-3 -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Target, Bay, and Group.</maml: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:\> Remove-HPEOALDAPBay -Connection $connection Target not provided... Use same Target for all Connections? (y/n): y Please enter Target (Acceptable values are Server,Interconnect): Server Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 1-3 Group not provided... Use same Group for all Connections? (y/n): n Please enter Group for 192.168.241.254: ldap2 Please enter Group for 192.168.242.64: ldap3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Target, Bay, and Group are not provided, you are prompted to input the values.</maml: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:\> $connection | Remove-HPEOALDAPBay -Target server -Bay 1-3 -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOALDAPGroup</command:name> <maml:description> <maml:para>Removes LDAP group from the system.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOALDAPGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOALDAPGroup cmdlet removes LDAP group from the system. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOALDAPGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>Name of LDAP group that is to be removed. Possible values are All or <group name>. Group name must be 1 to 255 characters in length. Character set includes all printable characters, except quotation marks and new lines. The group name must start with an alpha character. If you specify All, then all LDAP groups are removed from the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOALDAPGroup requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOALDAPGroup -Connection $connection -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Group.</maml: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:\> Remove-HPEOALDAPGroup -Connection $connection Group not provided... Use same Group for all Connections? (y/n): n Please enter Group for 192.168.241.254: ldap2 Please enter Group for 192.168.242.64: ldap3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Group parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Remove-HPEOALDAPGroup -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOALDAPPrivilege</command:name> <maml:description> <maml:para>Disables access to the Onboard Administrator for the group specified.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOALDAPPrivilege</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOALDAPPrivilege cmdlet disables access to the Onboard Administrator for the group specified. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOALDAPPrivilege</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>LDAP group name for which access to the onboard administrator is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOALDAPPrivilege requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOALDAPPrivilege -Connection $connection -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Group.</maml: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:\> Remove-HPEOALDAPPrivilege -Connection $connection Group not provided... Use same Group for all Connections? (y/n): n Please enter Group for 192.168.241.254: ldap2 Please enter Group for 192.168.242.64: ldap3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Group parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Remove-HPEOALDAPPrivilege -Group ldap1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOASNMPTrapReceiver</command:name> <maml:description> <maml:para>Removes an IP address from the list of systems that receive SNMP traps.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOASNMPTrapReceiver</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOASNMPTrapReceiver cmdlet removes an IP address from the list of systems that receive SNMP traps. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOASNMPTrapReceiver</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Host</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>CommunityName</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineId</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>SNMPv3</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Host</maml:name> <maml:description> <maml:para>The host which is removed from the list of systems that receive SNMP traps. The Host value can be either an IPv4 address, an IPv6 address, or a DNS name. IPv6 addresses cannot specify the network prefix length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>If the same Host is listed multiple times with different communities, all instances of the Host disappear unless CommunityName specifies which one is to be removed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the username for which the traps are removed for the host/username combination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineId</maml:name> <maml:description> <maml:para>Sets the engine ID for the user account. If set, the engine ID must be a series of hexadecimal characters, up to 32 bytes or 64 characters in length. This parameter is used for creating remote accounts used with Inform messages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>SNMPv3</maml:name> <maml:description> <maml:para>Specifies a switch parameter to indicate version number. If this parameter is set, then SNMP v3 traps are removed. If this parameter is set, the Host and Username parameters are needed and EngineID parameter is optional. If this parameter is not set , Host should be provided and CommunityName is optional.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOASNMPTrapReceiver requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOASNMPTrapReceiver -Connection $connection -Host 1.1.1.1</dev:code> <dev:remarks> <maml:para>This example shows one way to use the basic parameters to remove SNMP Trap Receiver. Parameters in this example must be provided. You can also use more parameters to specify the users.</maml: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:\> Remove-HPEOASNMPTrapReceiver -Connection $connection -Host "1.1.1.1" -Username "UserA" -SNMPv3</dev:code> <dev:remarks> <maml:para>This example shows another way to use the basic parameters to remove SNMP Trap Receiver. Parameters in this example must be provided. You can also use more parameters to specify the users. Depending on the OA firmware version, OA may support the command in example 1, command in example 2, or both.</maml: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:\> Remove-HPEOASNMPTrapReceiver -Connection $connection Host not provided... Please enter Host: 2.2.2.2 </dev:code> <dev:remarks> <maml:para>This example uses interactive input to remove an SNMP Trap Receiver.</maml: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>PS C:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "Host"="3.3.3.3" } PS C:\> $p | Remove-HPEOASNMPTrapReceiver </dev:code> <dev:remarks> <maml:para>This example removes an SNMP Trap Receiver in pipeline.</maml: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>PS C:\> $connection | Remove-HPEOASNMPTrapReceiver –Host “4.4.4.4”</dev:code> <dev:remarks> <maml:para>This example removes an SNMP Trap Receiver using pipeline and command line parameters.</maml: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>PS C:\> $connection | Remove-HPEOASNMPTrapReceiver Host not provided... Please enter Host:5.5.5.5 </dev:code> <dev:remarks> <maml:para>This example removes an SNMP Trap Receiver using pipeline and interactive input.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOASNMPUser</command:name> <maml:description> <maml:para>Removes the specified SNMP user.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOASNMPUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOASNMPUser cmdlet removes the SNMP user specified by the username. This will also delete all the traps/informs associated with the specified user.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOASNMPUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineId</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the SNMP user to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineId</maml:name> <maml:description> <maml:para>Specifies the optional Engine Id value. If this value is specified, users matching the Username and Engine Id pair are deleted. If this value is not specified, all users matching the Username are deleted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOASNMPUser requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOASNMPUser -Connection $connection -Username "UserA"</dev:code> <dev:remarks> <maml:para>This example uses the basic parameters to remove an SNMP user. Parameters in this example must be provided. Also you can use more parameters to specify the users.</maml: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:\> Remove-HPEOASNMPUser -Connection $connection Username not provided... Please enter Username: UserB </dev:code> <dev:remarks> <maml:para>This example uses interactive input to remove an SNMP user.</maml: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:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "Username"="UserC" } PS C:\> $p | Remove-HPEOASNMPUser </dev:code> <dev:remarks> <maml:para>This example removes an SNMP user in pipeline.</maml: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>PS C:\> $connection | Remove-HPEOASNMPUser –Username “UserD”</dev:code> <dev:remarks> <maml:para>This example removes an SNMP user using pipeline and command-line parameters.</maml: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>PS C:\> $connection | Remove-HPEOASNMPUser Username not provided... Please enter Username: UserE </dev:code> <dev:remarks> <maml:para>This example removes an SNMP user using pipeline and interactive input.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOATrustedHost</command:name> <maml:description> <maml:para>Removes an IPv4 or IPv6 address from the list of addresses being handled by the IP Security feature.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOATrustedHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOATrustedHost cmdlet removes an IPv4 or IPv6 address from the list of addresses being handled by the IP Security feature. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOATrustedHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>IP address to be removed from list of addressed being handled by IP security feature. If IPv4 is used, it must be in the form ###.###.###.###, where each ### ranges from 0 to 255.</maml:para> <maml:para>If IPv6 is used, it must be in the form ####:####:####:####:####:####:####:#### or ####:####:####:####:####:####:####:####/### (with a prefix), where each #### ranges from 0 to FFFF and the prefix /### ranges from 0 to 128.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOATrustedHost requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOATrustedHost -Connection $connection -IP 192.168.240.23</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with IP.</maml: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:\> Remove-HPEOATrustedHost -Connection $connection IP not provided... Use same IP for all Connections? (y/n): n Please enter IP for 192.168.241.254: fe80::555:64ff:fe34:5175/64 Please enter IP for 192.168.242.64: 192.168.240.18 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the IP parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Remove-HPEOATrustedHost -IP 192.168.240.23</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOAUser</command:name> <maml:description> <maml:para>Removes a user from the system.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOAUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOAUser cmdlet removes a user from the system. The Administrator account cannot be removed. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOAUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>The user name to be removed from the system. If you specify ALL, the command is run for all users except the default system accounts. The Username is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOAUser requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOAUser -Connection $connection -Username user1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Username.</maml: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:\> Remove-HPEOAUser -Connection $connection Username not provided... Use same Username for all Connections? (y/n): n Please enter Username for 192.168.241.254: user2 Please enter Username for 192.168.242.64: user3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Username parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Remove-HPEOAUser -Username user1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOAUserBay</command:name> <maml:description> <maml:para>Remove user access from the specified bay.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOAUserBay</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOAUserBay cmdlet removes user access from the specified bay. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOAUserBay</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target device name for which the access is being removed. Possible values are Server and Interconnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="bayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the device(s) for which access is being removed. Bay can be specified as <Bay number>, All, and <bay number>-<bay number>.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>The user name for which the access is being removed. The Username is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOAUserBay requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOAUserBay -Connection $connection -Target Interconnect -Bay 1-3 -Username user1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Target, Bay, and Username.</maml: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:\> Remove-HPEOAUserBay -Connection $connection Target not provided... Use same Target for all Connections? (y/n): y Please enter Target (Acceptable values are Server,Interconnect): Server Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 1-3 Username not provided... Use same Username for all Connections? (y/n): n Please enter Username for 192.168.241.254: user2 Please enter Username for 192.168.242.64: user3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Target, Bay, and Username are not provided, you are prompted to input the values.</maml: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:\> $connection | Remove-HPEOAUserBay -Target Interconnect -Bay 1-3 -Username user1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOAUserCertificate</command:name> <maml:description> <maml:para>Removes the certificate associated with a user.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOAUserCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOAUserCertificate cmdlet removes the certificate associated with a user. If Two-Factor Authentication is enabled, this user no longer has access through HTTPS. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOAUserCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>The user name for which the certificates are being removed. The Username is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOAUserCertifcate requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOAUserCertificate -Connection $connection -Username user1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Username.</maml: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:\> Remove-HPEOAUserCertificate -Connection $connection Username not provided... Use same Username for all Connections? (y/n): n Please enter Username for 192.168.241.254: user2 Please enter Username for 192.168.242.64: user3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Username parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Remove-HPEOAUserCertificate -Username user1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOAUserPrivilege</command:name> <maml:description> <maml:para>Removes the Onboard Administrator from the control of the user to whom the Onboard Administrator is currently assigned.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOAUserPrivilege</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOAUserPrivilege cmdlet removes the Onboard Administrator from the control of the user to whom the Onboard Administrator is currently assigned. A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOAUserPrivilege</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>The user name for which access to the Onboard Administrator is being removed. The Username is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOAUserPrivilege requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOAUserPrivilege -Connection $connection -Username user1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Username.</maml: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:\> Remove-HPEOAUserPrivilege -Connection $connection Username not provided... Use same Username for all Connections? (y/n): n Please enter Username for 192.168.241.254: user2 Please enter Username for 192.168.242.64: user3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Username parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Remove-HPEOAUserPrivilege -Username user1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HPEOAVLAN</command:name> <maml:description> <maml:para>Removes a VLAN ID.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOAVLAN</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOAVLAN cmdlet removes a VLAN ID. All devices currently using that VLAN ID are moved to the default VLAN ID. You cannot remove the default VLAN ID. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HPEOAVLAN</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <maml:description> <maml:para>The VLAN ID to remove. Must be an integer from 1 to 4094.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Remove-HPEOAVLAN requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Remove-HPEOAVLAN –connection $connection –VLANID 50</dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as parameter along with VLANID.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Remove-HPEOAVLAN -Connection $connection VLANID not provided... Use same VLANID for all Connections? (y/n): y Please enter VLANID: 50 </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the VLANID parameter is not provided for the OAs, you are asked to input the value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Remove-HPEOAVLAN –VLANID 50</dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-HPEOA</command:name> <maml:description> <maml:para>Restarts the blade server specified by bay number.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPEOA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPEOA cmdlet restarts the blade server specified by bay number. If the target device is Server, a request is sent to the blade to perform a graceful shutdown. The blade is then powered on. If the Force option is specified, the OS might not perform a graceful shutdown before power is recycled on the server.</maml:para> <maml:para>If no bay number is given when Onboard Administrator is specified as a target, then the Onboard Administrator the user is logged in to is restarted. You must have access to the specified bay number for resetting the specified interconnect or server. This cmdlet is not applicable to storage blades.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator can reset the Onboard Administrator. An administrator or an operator can reset the interconnect or server if they have access to the specified bay.</maml:para> <maml:para>Warning: All connections are disconnected if OA is reset.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-HPEOA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>ApplyNow</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>BootOrder</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target device type which is being reset. Possible values are OA, Server, or Interconnect. If the value is set to OA or Interconnect, then the values for ApplyNow and BootOrder are not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the Onboard Administrator, server or interconnect which are being reset. Possible values can be All or bay number(s) specified as <bay number> [,|- <bay number>]).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>ApplyNow</maml:name> <maml:description> <maml:para>If this option is set, the OS might not perform a graceful shutdown before power is recycled for the server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>Boot order for the server after it is reset. Possible values are Normal, PXE, HDD and RBSU.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Reset-HPEOA requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Reset-HPEOA -Connection $connection -Target Server -Bay 2 -ApplyNow IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.242.64 southwind.company.net Warning Forcing reboot of Blade 2 </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Target,Bay and ApplyNow.</maml: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:\> Reset-HPEOA -Connection $connection -Bay 2 -ApplyNow Target not provided... Use same Target for all Connections? (y/n): y Please enter Target (Acceptable values are Server, Interconnect, OA): Server IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.242.64 southwind.company.net Warning Forcing reboot of Blade 2 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Target is not provided, you are prompted to input the value.</maml: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:\> $connection | Reset-HPEOA -Target Server -Bay 2 -ApplyNow IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.242.64 southwind.company.net Warning Forcing reboot of Blade 2 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-HPEOAEBIPA</command:name> <maml:description> <maml:para>Saves EBIPA settings to a flash drive.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Save</command:verb> <command:noun>HPEOAEBIPA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Save-HPEOAEBIPA cmdlet saves EBIPA settings to a flash drive. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-HPEOAEBIPA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>IPV6</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>IPV6</maml:name> <maml:description> <maml:para>Switch parameter that saves EBIPA v6 settings to flash drive.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Save-HPEOAEBIPA requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Save-HPEOAEBIPA -Connection $connection -IPV6</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with IPV6.</maml: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:\> $connection | Save-HPEOAEBIPA –IPV6</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-HPEOAVLAN</command:name> <maml:description> <maml:para>Saves VLAN configuration to a flash drive.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Save</command:verb> <command:noun>HPEOAVLAN</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Save-HPEOAVLAN cmdlet saves VLAN configuration to a flash drive. This command applies only to VLAN configuration data. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-HPEOAVLAN</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Save-HPEOAVLAN requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Save-HPEOAVLAN -Connection $connection</dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Save-HPEOAVLAN</dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-HPEOAVLANIPConfig</command:name> <maml:description> <maml:para>Saves VLAN IPCONFIG changes to a flash drive.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Save</command:verb> <command:noun>HPEOAVLANIPConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Save-HPEOAVLANIPConfig cmdlet saves VLAN IPCONFIG changes to a flash drive. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-HPEOAVLANIPConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Save-HPEOAVLANIPConfig requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Save-HPEOAVLANIPConfig -Connection $connection</dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Save-HPEOAVLANIPConfig</dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-HPEOADataCollection</command:name> <maml:description> <maml:para>Sends a data collection to a remote server.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>HPEOADataCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Send-HPEOADataCollection cmdlet sends a data collection to a remote server. Remote Support must be enabled before sending a data collection. If the enclosure contains a large number of blades, the test might take several minutes. After the test is complete, the status is reflected in the Get-HPEOARemoteSupport command output.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-HPEOADataCollection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Send-HPEOADataCollection requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Send-HPEOADataCollection –Connection $connection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : Warning StatusMessage : Data collection was started. Please run 'Get-HPEOARemoteSupport' to view status. </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. </maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Send-HPEOADataCollection IP : 192.168.242.64 Hostname : southwind.company.net StatusType : Error StatusMessage : This operation cannot be performed when Remote Support is disabled. </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAActiveHealthSystem</command:name> <maml:description> <maml:para>Enables or disables logging of inventory and health status for shared infrastructure items such as fans and power supplies to the blades that depend upon them.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAActiveHealthSystem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAActiveHealthSystem cmdlet enables or disables logging of inventory and health status for shared infrastructure items such as fans and power supplies to the blades that depend upon them.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAActiveHealthSystem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables the logging of health and inventory status. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAActiveHealthSystem requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAActiveHealthSystem -Connection $connection -State Disable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOAActiveHealthSystem -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State: Enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted for the values.</maml: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:\> $connection | Set-HPEOAActiveHealthSystem -State Disable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAAlertmail</command:name> <maml:description> <maml:para>Enables or disables the sending of alert emails when an event occurs and edits the Alertmail settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAAlertmail</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAAlertmail cmdlet enables or disables the sending of alert emails when an event occurs and edits the Alertmail settings. You can only set the state to enable if the configuration has been set up.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem parametersetname="SenderDomain"> <!--NAME: SenderDomain--> <maml:name>Set-HPEOAAlertmail</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> <maml:para>ParameterSetName: (All) Aliases: conn</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables alert mails when an event occurs. Possible values are Enable and Disable.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address to which the alert mails are sent.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="Domain"> <maml:name>SenderDomain</maml:name> <maml:description> <maml:para>Identifies the DNS domain where the Onboard Administrator is located (for example, AB.com).</maml:para> <maml:para>ParameterSetName : SenderDomain Aliases: Domain</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SMTPServer</maml:name> <maml:description> <maml:para>Identifies the mail server where the Onboard Administrator delivers its e-mail based events.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>SenderName</maml:name> <maml:description> <maml:para>Specify the email sender name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAAlertmail requires you to provide the values of all required parameters.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="SenderEmail"> <!--NAME: SenderEmail--> <maml:name>Set-HPEOAAlertmail</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> <maml:para>ParameterSetName: (All) Aliases: conn</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables alert mails when an event occurs. Possible values are Enable and Disable.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address to which the alert mails are sent.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>SenderEmail</maml:name> <maml:description> <maml:para>Specify the sender email address.</maml:para> <maml:para>ParameterSetName : SenderEmail</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SMTPServer</maml:name> <maml:description> <maml:para>Identifies the mail server where the Onboard Administrator delivers its e-mail based events.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>SenderName</maml:name> <maml:description> <maml:para>Specify the email sender name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAAlertmail requires you to provide the values of all required parameters.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> <maml:para>ParameterSetName: (All) Aliases: conn</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables alert mails when an event occurs. Possible values are Enable and Disable.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address to which the alert mails are sent.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Domain"> <maml:name>SenderDomain</maml:name> <maml:description> <maml:para>Identifies the DNS domain where the Onboard Administrator is located (for example, AB.com).</maml:para> <maml:para>ParameterSetName : SenderDomain Aliases: Domain</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>SMTPServer</maml:name> <maml:description> <maml:para>Identifies the mail server where the Onboard Administrator delivers its e-mail based events.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>SenderName</maml:name> <maml:description> <maml:para>Specify the email sender name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>SenderEmail</maml:name> <maml:description> <maml:para>Specify the sender email address.</maml:para> <maml:para>ParameterSetName : SenderEmail</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAAlertmail requires you to provide the values of all required parameters.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAAlertmail -Connection $connection -State Enable -Email xxxx@hp.com -SenderDomain domain.com -SMTPServer xx.xx.xx.xx</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with State, Email, Domain, and SMTPServer.</maml: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:\> $connection | Set-HPEOAAlertmail -State Disable Email xxxx@hp.com -SenderDomain abcdomain.com -SMTPServer xx.xx.xx.xx</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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>C:\PS> $connection | Set-HPEOAAlertmail -SenderName "Support team" -SenderEmail abc.xyz@domain.com</dev:code> <dev:remarks> <maml:para>This example sets the sender name and sender email using connection object as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-HPEOAAlertmail</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOABladeDeviceSerialNumber</command:name> <maml:description> <maml:para>Sets the serial number of the specified Storage, Tape, or I/O expansion blade.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOABladeDeviceSerialNumber</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOABladeDeviceSerialNumber cmdlet sets the serial number of the specified Storage, Tape, or I/O expansion blade. This operation cannot be performed on server blades.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOABladeDeviceSerialNumber</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>SerialNumber</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number for the device for which the serial number is to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>- Length must be 10 characters. All printable characters are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOABladeDeviceSerialNumber requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOABladeDeviceSerialNumber -Connection $connection -Bay 1 -SerialNumber US23456789</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Bay and SerialNumber.</maml: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:\> Set-HPEOABladeDeviceSerialNumber -Connection $connection Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 1 SerialNumber not provided... Use same SerialNumber for all Connections? (y/n): y Please enter SerialNumber: US23456789 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Bay and SerialNumber parameters are not provided, you are prompted to input the values.</maml: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:\> $connection | Set-HPEOABladeDeviceSerialNumber -Bay 1 -SerialNumber US23456789</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOADate</command:name> <maml:description> <maml:para>Sets the date of the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOADate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOADate cmdlet sets the date of the enclosure. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOADate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Date</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Date</maml:name> <maml:description> <maml:para>The date is set using the following format: MMDDhhmm[[CC]YY] [TZ]</maml:para> <maml:para>- MM: Month (an integer from 01 to 12) - DD: Day (an integer from 01 to 31) - hh: Hour (an integer from 00 to 24) - mm: Minute (an integer from 00 to 60) - CC: Century - YY: Year - TZ: Time zone (if time zone is blank, the current time zone is used)</maml:para> <maml:para>NOTE. Date and time can only be set if NTP is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOADate requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $dt = (Get-Date -Format "MMddHHmmyyyy") + " US/Central" PS C:\> $dt 060321592014 US/Central PS C:\> Set-HPEOADate -Connection $connection -Date $dt </dev:code> <dev:remarks> <maml:para>The Get-Date Microsoft cmdlet can be used to retrieve the system date. This system date is used to set the date on the OA. Visit http://msdn.microsoft.com/en-us/library/system.globalization.datetimeformatinfo(VS.85).aspx to refer to .Net date and time format patterns that can be used in PowerShell. In this example the list of OA connection is passed as a parameter along with Date.</maml: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:\> Set-HPEOADate -Connection $connection Date not provided... Use same Date for all Connections? (y/n): y Please enter Date: : "060313432014 US/Central" </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Date parameter is not provided, you are prompted to input the values.</maml: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:\> $dt = "060313432014 US/Central" PS C:\> $connection | Set-HPEOADate -Date $dt</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOADHCPDomainName</command:name> <maml:description> <maml:para>Enables or disables DHCP domain name and sets the domain name for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOADHCPDomainName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOADHCPDomainName cmdlet enables or disables the DHCP domain name. Enabling the domain name requires that dynamic DNS is enabled. Disabling allows the user to enter a domain name instead of the one supplied by DHCP. If the user has previously disabled the DHCP-supplied domain name, this command disabling will cause the specified Onboard Administrator to revert to using the DHCP domain name. If dynamic DNS is enabled, then the enabling will succeed, otherwise enabling will fail with an error.</maml:para> <maml:para>If DHCP domain name has been disabled, the domain name specified by this command will override the DHCP domain name. This also requires the dynamic DNS is enabled on the Onboard Administrator. If the domain name has syntax error, the response will be an error message stating that the argument is invalid argument.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOADHCPDomainName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DomainName</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables DHCPv6. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Specifies the bay number of the Onboard Administrator for which the domain name is to be changed. Possible values are Active, Passive, or the bay number of Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name for the Onboard Administrator. Possible values can be the specific domain name or None. To clear the domain name, set the DomainName parameter to None.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOADHCPDomainName requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOADHCPDomainName -Connection $connection -State Enable -Bay 2 -DomainName China</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with State, Bay, and DomainName.</maml: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:\> $connection | Set-HPEOADHCPDomainName -State Enable -Bay 2 -DomainName China</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOADHCPv6</command:name> <maml:description> <maml:para>Enables or disables DHCPv6 mode for management interfaces of all devices in the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOADHCPv6</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOADHCPv6 cmdlet enables or disables DHCPv6 mode for management interfaces of all devices in the enclosure. In DHCPv6 mode, IPv6 and DNS addresses are obtained from the DHCPv6 Server. This setting takes effect immediately.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOADHCPv6</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables DHCPv6. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOADHCPv6 requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOADHCPv6 -Connection $connection -State Disable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOADHCPv6 -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State: Enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOADHCPv6 -State Disable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAEBIPA</command:name> <maml:description> <maml:para>Enables or disables the Onboard Administrator to provide IP addresses to the devices in the bays using DHCP.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAEBIPA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>CAUTION. This command cycles power to the interconnect and causes a loss of connectivity.</maml:para> <maml:para>The Set-HPEOAEBIPA cmdlet enables or disables the Onboard Administrator to provide IP addresses to the devices in the bays using DHCP. This cmdlet also modifies EBIPA settings for bay device(s). If you do not specify any bay numbers, then EBIPA is enabled for all bays.</maml:para> <maml:para>DHCP traffic from iLO and the switch modules can no longer go outside the enclosure. This causes a reset of the iLO, which causes it to attempt to get an IP address. The interconnect is power-cycled.</maml:para> <maml:para>Before using this command you must set up the EBIPA settings. This includes setting the initial IP address, the netmask, and the default gateway.</maml:para> <maml:para>NOTE. Do not use the 169.254.x.x range when configuring EBIPA-assigned addresses as this network address range is reserved for use by the Onboard Administrator.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAEBIPA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Netmask</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Gateway</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Domain</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>NTP</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>NTPIP</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>IPV6</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables EBIPA. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target device type for which EBIPA settings are being modified. Possible values are Server and Interconnect. If the value is set to Server, then value for NTP and NTPIP parameters are not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>IP address of EBIPA server. To clear the IP address values, use keywords None. The IP address must be in the form ###.###.###.###, where each ### ranges from 0 to 255.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Netmask</maml:name> <maml:description> <maml:para>Netmask of the EBIPA server. To clear the netmask values, use keywords None. The netmask must be in the form ###.###.###.###, where each ### ranges from 0 to 255.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Gateway</maml:name> <maml:description> <maml:para>Gateway for EBIPA.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Domain</maml:name> <maml:description> <maml:para>The Domain is a string containing letters (a–z, A–Z), digits (0–9), or a dash (-). The Onboard Administrator accepts domain name character strings subject to the following constraints: - The string must be between 1 and 255 characters in length. - The characters are case insensitive. - The first character of the domain name must be alphanumeric, while the last character can be either alphanumeric or a period. - The characters between the first and last character can be alphanumeric, dash or period. - If one or more periods appear in the name, they are used to delimit labels. - Labels are between 1 and 63 characters long and begin and end with an alphanumeric character. - The last label is referred as the top-level domain and cannot consist of all numeric characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>NTP</maml:name> <maml:description> <maml:para>NTP type for EBIPA interconnect. Possible values are Primary or Secondary.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>NTPIP</maml:name> <maml:description> <maml:para>IP of the NTP server to be used for the Interconnect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the device(s) where the EBIPA setting are being applied. Possible values are All | <Bay number> | <bay number>[,|- <bay number>].</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>IPV6</maml:name> <maml:description> <maml:para>Switch parameter that modifies the settings for EBIPA IPv6.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAEBIPA requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAEBIPA -Connection $connection -State Enable -Target Server -IP 192.168.243.112 -Netmask 255.255.248.0 -Gateway 192.168.240.1 -Domain xxx -Bay 1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with State, Target, IP, Netmask, Gateway, Domain, and Bay.</maml: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:> Set-HPEOAEBIPA -Connection $connection -State Enable -IP 192.168.243.112 -Netmask 255.255.248.0 -Gateway 192.168.240.1 -Domain xxx -Bay 1 Target not provided... Use same Target for all Connections? (y/n): y Please enter Target: Server </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Target parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAEBIPA State Enable -Target Server -IP 192.168.243.112 -Netmask 255.255.248.0 -Gateway 192.168.240.1 -Domain xxx -Bay 1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAEnclosure</command:name> <maml:description> <maml:para>Sets the enclosure details.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAEnclosure</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAEnclosure cmdlet sets the enclosure details. Part number, PDU_Type, and Serial number can be set only by OA administrator. Asset tag and name can be set by the OA administrator or OA operator.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAEnclosure</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>AssetTag</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Name</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PartNumber</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PDUType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SerialNumber</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>AssetTag</maml:name> <maml:description> <maml:para>The default enclosure asset tag is blank. The <asset tag> must be 0 to 32 characters long and includes all alphanumeric, underscore (_), and dash (-) characters. (Optional when any other parameter is provided.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>The default enclosure name is the mid-plane serial number. The <enclosure name> must be 1 to 32 characters long and includes all alphanumeric, underscore (_), and dash (-) characters. (Optional when any other parameter is provided.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PartNumber</maml:name> <maml:description> <maml:para>Part number of the enclosure. Must be 10 characters in length and the first character must be a digit. Acceptable characters are all alphanumeric and the dash (-). (Optional when any other parameter is provided.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PDUType</maml:name> <maml:description> <maml:para>Sets the enclosure PDU type. (Optional when any other parameter is provided.) The following are valid values: 1=Single-phase 2=Three-phase 3=Three-phase, international 4=DC Power Input Module 5=Single phase IPD 6=HPHVDC_1PH_AC_Module</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>Must be 10 characters in length. Acceptable characters are all printable characters. (Optional when any other parameter is provided.) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAEnclosure requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAEnclosure -Connection $connection -PartNumber 0123456789</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with PartNumber.</maml: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:\> Set-HPEOAEnclosure -Connection $connection -AssetTag info_assettag</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection | Set-HPEOAEnclosure -PDUType Single_Phase</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAEnclosureiLOFederationSupport</command:name> <maml:description> <maml:para>Enables or disables Onboard Administrator support required to allow peer-to-peer network communication necessary for iLO Federation.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAEnclosureiLOFederationSupport</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAEnclosureiLOFederationSupport cmdlet enables or disables the OA support required to allow peer-to-peer network communication necessary for iLO Federation among suitably capable iLOs within the enclosure.</maml:para> <maml:para>NOTE. Enable Enclosure iLO Federation Support only enables Onboard Administrator support to allow the peer-to-peer network communication necessary for iLO Federation among iLOs within the enclosure. To fully enable iLO Federation, each iLO must have the appropriate firmware and be configured to participate in iLO Federation. For more information, see the HP iLO 4 User Guide at the HP website (http://www.hp.com/go/ilo/docs).</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAEnclosureiLOFederationSupport</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enable or disable OA iLO Federation support. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAEnclosureiLOFederationSupport requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAEnclosureiLOFederationSupport -Connection $connection -State Enable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOAEnclosureiLOFederationSupport -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State: Disable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAEnclosureiLOFederationSupport -State Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAEnclosureIPMode</command:name> <maml:description> <maml:para>Enables or disables enclosure IP mode.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAEnclosureIPMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAEnclosureIPMode cmdlet enables or disables enclosure IP mode. When using enclosure IP mode only replace the standby OA module while the enclosure is powered on to ensure persistence of Enclosure IP Mode settings. You cannot execute Enable-HPEOAEnclosureIPMode in FIPS Mode ON/DEBUG.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAEnclosureIPMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enable or disable enclosure IP mode. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAEnclosureIPMode requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAEnclosureIPMode -Connection $connection -State Disable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOAEnclosureIPMode -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State: Enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are promoted to input the value.</maml: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:\> $connection | Set-HPEOAEnclosureIPMode -State Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAEnclosurePowerCap</command:name> <maml:description> <maml:para>Sets the Enclosure Dynamic Power Cap in watts AC.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAEnclosurePowerCap</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAEnclosurePowerCap cmdlet sets the Enclosure Dynamic Power Cap in watts AC. Average power cannot exceed cap or derated circuit capacity. Peak power cannot exceed rated circuit capacity. For example, suppose the PDU powering the enclosure has a rated capacity of 30 amps. In North America and Japan, the standard de-rating ratio is 80%, so the PDU has a derated capacity of 24 amps (0.80 * 30). At 208 volts, the Rated Circuit Capacity would be entered as 6240 watts (30 * 208), and the Derated Circuit Capacity would be entered as 4992 watts (24 * 208). </maml:para> <maml:para>When specifying only cap, the other values are calculated using the standard de-rating ratio for North America. Therefore derated circuit capacity is equal to cap and rated_circuit_capacity is equal to 1.25 * cap. The Enclosure Dynamic Power Cap and Derated Circuit Capacity can be specified as any value in the allowable range. The Derated Circuit Capacity must be at least as large as the Enclosure Dynamic Power Cap and no larger than the Rated Circuit Capacity. The Enclosure Dynamic Power Cap can be used to limit enclosure power consumption based on a cooling constraint that might be lower than the Derated Circuit Capacity.</maml:para> <maml:para>Blades in omitted bays are treated as unmanaged components of the system: They receive a maximum power allocation even when the power is not being consumed, raising the minimum Enclosure Dynamic Power Cap value that can be applied to the enclosure. Any blades in bays not specified are managed. If you have previously specified bays to exclude, using this command again replaces that specification rather than augmenting it. You can exclude no more than one fourth of the bays.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAEnclosurePowerCap</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>PowerCap</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>DeratedCap</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>RatedCap</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>PowerCap</maml:name> <maml:description> <maml:para>Powercap value to be set to the enclosure. Values are Off | <Cap value>. If PowerCap value is set to Off, the enclosure dynamic power cap is disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>DeratedCap</maml:name> <maml:description> <maml:para>The derated circuit capacity. Average power cannot exceed PowerCap or DeratedCap.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>RatedCap</maml:name> <maml:description> <maml:para>The rated circuit capacity. Peak power cannot exceed RatedCap.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) to omit from enclosure's Powercap. Values are <bay number>[,|- <bay number>] | None.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAEnclosurePowerCap requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAEnclosurePowerCap -Connection $connection -Bay $bay </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter along with Bay.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAEnclosurePowerCap -Connection $connection -PowerCap 5555 -DeratedCap 6666 -RatedCap 7777 </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet along with PowerCap, DeratedCap, and RatedCap. It can be an Object or an Object array returned from Connect-HPEOA. </maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAEnclosurePowerCap -PowerCap 6666 </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAFactoryDefault</command:name> <maml:description> <maml:para>Restores the Onboard Administrator to its factory defaults.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAFactoryDefault</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAFactoryDefault cmdlet restores the Onboard Administrator to its factory defaults. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> <maml:para>Warning: All existing settings are lost and OA is restarted when this operation is executed, but the Administrator account and its password are not changed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAFactoryDefault</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>RestoreFactoryPassword</maml:name> <maml:description> <maml:para>Specify this SwitchParameter to reset the Onboard Administrator password to its factory default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAFactoryDefault requires you to provide the values of all required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>RestoreFactoryPassword</maml:name> <maml:description> <maml:para>Specify this SwitchParameter to reset the Onboard Administrator password to its factory default.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAFactoryDefault requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAFactoryDefault -Connection $connection</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed.</maml: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:\> $connection | Set-HPEOAFactoryDefault</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection | Set-HPEOAFactoryDefault -RestoreFactoryPassword</dev:code> <dev:remarks> <maml:para>In this example Onboard Administrator and its password reset to factory default, where $connection object is passed to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAFIPSMode</command:name> <maml:description> <maml:para>Enables or disables use of the Onboard Administrator in a FIPS 140-2-compliant mode.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAFIPSMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAFIPSMode cmdlet enables or disables use of the Onboard Administrator in a FIPS 140-2-compliant mode. </maml:para> <maml:para>Warning: Any changes to the FIPS setting perform a Restore to Factory Default operation. All changes in OA get lost and OA is restarted when the operation is done. </maml:para> <maml:para> If the change is to On or Debug state, strong passwords are enabled, minimum password length is set to eight characters, and a new Administrator account password is requested.</maml:para> <maml:para>When the Onboard Administrator is operating in FIPS Mode, certificates must have a minimum RSA key length of 2048 bits, and the signature hash algorithm must be SHA1, SHA-224, SHA-256, SHA-384, or SHA-512.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAFIPSMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Password</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state to be set for FIPS mode. The following are valid values: - On: Setting the state to On enforces use of the Onboard Administrator in a FIPS 140-2-compliant mode,using only FIPS 140-2 approved algorithms such as AES and TLSv1.2. Setting this option to OFF also enables other SSLv3 algorithms such as RSA, RC4, and MD5. For this mode, strong passwords are enabled, minimumpassword length is set to eight characters, and a new Administrator account password is required. This can be provided using the Password parameter. - Debug: Using the Debug option sets the Onboard Administrator to the environment where the FIPS mode is On, but with the possibility of debug support from HP (Debug has the functionalities of On but is not considered FIPS-compliant due to the debug option). For this mode, strong passwords are enabled, minimumpassword length is set to eight characters, and a new Administrator account password is required. This can be provided using the Password parameter. - Off: Setting State parameter to OFF also enables other SSLv3 algorithms such as RSA, RC4, and MD5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the strong password required for the 'On' or 'Debug' mode specified in the 'State' parameter. Minimum password length is eight.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAFIPSMode requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAFIPSMode -Connection $connection -State Debug -Password passwordA IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.242.64 southwind.company.net Warning FIPS Mode is successfully set to DEBUG.... </dev:code> <dev:remarks> <maml:para>This example shows that an OA connection is passed as a parameter along with State and Password.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAFIPSMode -Connection $connection -Password passwordA State not provided... Please enter State for 192.168.242.64 (Acceptable values are On,Debug,Off): On IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.242.64 southwind.company.net Warning FIPS Mode is successfully set to ON.... </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are asked to input its value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAFIPSMode -State Off IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.242.64 southwind.company.net Warning FIPS Mode is successfully set to OFF.... </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAFWManagement</command:name> <maml:description> <maml:para>Enables or disables enclosure firmware management and configures the firmware management settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAFWManagement</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAFWManagement cmdlet enables or disables enclosure firmware management and configures the firmware management settings. It configures which server bays are included in the Enclosure Firmware Management policy. If bays were included in a previous operation, then you must reselect the bays. The bays_to_include feature only applies to ProLiant server blades. Integrity server blades do not support this feature. Partner blade support is provided through the associated server blade based on whether the firmware ISO supports the PCIe adapter card in the partner blade.</maml:para> <maml:para>Enable the Policy option to force all devices to have firmware updated to the version supplied by the ISO, even if a newer version is currently installed on the device. This option is disabled by default.</maml:para> <maml:para>The firmware management control policy can be set using this command. This command can also set the date and time to run a scheduled update. Enclosure Firmware Management must be enabled and a firmware management URL must be specified.</maml:para> <maml:para>The URL parameter sets the location on the management network of the HP Firmware ISO image. Supported protocols are HTTP, USB, and DVD. Format the URL as: protocol://host/path/filename. If the image is being used, the URL cannot be changed.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAFWManagement</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Downgrade</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Policy</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Power</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Schedule</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables enclosure firmware management. Possible values are Enable or Disable</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay ranges must be completely specified. Valid values are All|<bay number>[,|- <bay number> | None]</maml:para> <maml:para>Base bays, side a bays, and side b bays cannot be mixed in a single range. Ranges such as 1a-4b or 5-7a are not valid. Multiple ranges must be specified in the same statement.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Downgrade</maml:name> <maml:description> <maml:para>Possible values are Enable and Disable. Enable: Force all devices to have firmware updated to the version supplied by the ISO. Disable: Does not allow downgrade of the firmware version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Policy</maml:name> <maml:description> <maml:para>The following are valid options: - Manual: Update and discover manually. - AutoDiscover: Automatically discover server firmware on insertion. - AutoUpdate: Automatically update server firmware on insertion.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Power</maml:name> <maml:description> <maml:para>The following are valid options: - On: The server must be powered off or the Onboard Administrator cancels the operation. This is equivalent to pressing the Momentary Press virtual button for the server. This setting is the default. - Off: The Onboard Administrator attempts to softly shut down the server. This is equivalent to pressing the Momentary Press virtual button for the server. If server power remains on for more than five minutes, the Onboard Administrator cancels the operation. - Hold: The Onboard Administrator forces an immediate hard shutdown of the server. This is equivalent to pressing the Press and Hold virtual button for the server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>On</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Valid values are <YYYY-MM-DD> <HH:MM> | None. Use None to disable scheduled firmware updates.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>On</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>Sets the location on the management network of the HP Firmware ISO image. Valid values are 'DVD', <URL> and 'None'. Supported protocols are HTTP, USB, and DVD. Format the URL as: protocol://host/path/filename. The URL syntax for IPv6 addresses is protocol://[<ipv6 address>]/path/filename.</maml:para> <maml:para>If Enclosure Firmware Management is disabled, NONE clears the location of the HP Firmware ISO image. If the image is being used, the URL cannot be changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>On</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAFWManagement requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAFWManagement -Connection $connection -State $state -Bay $bay -Downgrade $downgrade -Policy $policy -Power $power -Schedule $schedule -URL $url </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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 | Set-HPEOAFWManagement -State $state -Bay $bay -Downgrade $downgrade -Policy $policy -Power $power -Schedule $schedule -URL $url </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAGateway</command:name> <maml:description> <maml:para>Sets the network default gateway</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAGateway</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAGateway cmdlet sets the network default gateway. This command is used if the system is configured to use a static IP address.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the Onboard Administrator for which the network default gateway is being set. The value is specified as <bay number>, Active, or Standby. If you do not specify a bay number, the command defaults to the active Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>The IPv4 address must be in the form ###.###.###.###, where each ### ranges from 0 to 255.The IPv6 must be in the form ####:####:####:####:####:####:####:####, where each #### ranges from 0 to FFFF. A compressed version of the same IPv6 address is also supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAGateway requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAGateway -Connection $connection -Bay 2 -IP 192.168.240.1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Bay and IP.</maml: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:\> Set-HPEOAGateway -Connection $connection Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 2 IP not provided... Use same IP for all Connections? (y/n): y Please enter IP: 192.168.240.1 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Bay and IP parameters are not provided, you are prompted to input the values.</maml: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:\> $connection | Set-HPEOAGateway -Bay 2 -IP 192.168.240.1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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>PS C:\> $connection | Set-HPEOAGateway -Bay 1 -IP 2001:0db8:85a3:0000:0000:8a2e:0370:7334</dev:code> <dev:remarks> <maml:para>In this example IPv6 gateway address is set for Bay 1 where connection object is passed through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAHPSIMTrustMode</command:name> <maml:description> <maml:para>Enables or disables the HP SIM SSO mode.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAHPSIMTrustMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAHPSIMTrustMode cmdlet enables or disables the HP SIM SSO mode. When enabled, the trusted applications can access the Onboard Administrator GUI data without requiring additional authentication.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAHPSIMTrustMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Mode</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Mode</maml:name> <maml:description> <maml:para> Valid values are Certificate | Disabled. The Certificate (On) mode trusts only applications with certificates that have been uploaded to the Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOASIMTrustMode requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAHPSIMTrustMode -Connection $connection -Mode Off</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Mode.</maml: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:\> Set-HPEOAHPSIMTrustMode -Connection $connection Mode not provided... Use same Mode for all Connections? (y/n): y Please enter Mode: On </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Mode parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAHPSIMTrustMode -Mode Off</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAHTTPS</command:name> <maml:description> <maml:para>Enables or disables HTTPS access to the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAHTTPS</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAHTTPS cmdlet enables or disables HTTPS access to the Onboard Administrator. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAHTTPS</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para> Valid values are Enable | Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAHTTPS requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAHTTPS -Connection $connection -State Disable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOAHTTPS -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State: Enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAHTTPS - State Disable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAIPConfig</command:name> <maml:description> <maml:para>Configures IP settings for the Onboard Administrator to DHCP or Static mode.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAIPConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAIPConfig cmdlet configures IP settings for the Onboard Administrator to DHCP or Static mode. In DHCP mode, the IP address, Netmask, Gateway address, and DNS addresses are obtained from the DHCP. This setting immediately takes effect.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAIPConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Mode</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Netmask</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Gateway</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DNS1</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DNS2</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>DynamicDNS</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Mode</maml:name> <maml:description> <maml:para> Onboard Administrator IP mode. Possible values are Static and DHCP. If the value is set to DHCP, then Values for Bay, IP, Netmask, Gateway, DNS1 and DNS2 are not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para> Onboard Administrator bay number whose IP configuration is to be modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para> Static IP address to be set when the Mode parameter is set to Static.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Netmask</maml:name> <maml:description> <maml:para>Subnet mask value to be set when Mode parameter is set to Static.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Gateway</maml:name> <maml:description> <maml:para>The gateway IP to be used when Mode parameter is set to Static.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DNS1</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address of a DNS server to be added to the OA DNS list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DNS2</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address of a DNS server to be added to the OA DNS list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>DynamicDNS</maml:name> <maml:description> <maml:para>If DynamicDNS is set, then the DNS server is notified of the new IP address of the system when it is received from the DHCP server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>No</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAIPConfig requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAIPConfig -Connection $connection -Mode Static -Bay 5 -IP 192.168.242.64 -Netmask 255.255.248.0 -Gateway 192.168.240.1 -DNS1 xxx1 -DNS2 xxx2</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Mode, Bay, IP, Netmask, Gateway, DNS1, and DNS2.</maml: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:\> Set-HPEOAIPConfig -Connection $connection -Bay 5 -IP 192.168.242.64 -Netmask 255.255.248.0 -Gateway 192.168.240.1 -DNS1 xxx1 -DNS2 xxx2 Mode not provided... Use same Mode for all Connections? (y/n): y Please enter Mode: Static </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Mode parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAIPConfig -Mode Static -Bay 5 -IP 192.168.242.64 -Netmask 255.255.248.0 -Gateway 192.168.240.1 -DNS1 xxx1 -DNS2 xxx2</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAIPv6</command:name> <maml:description> <maml:para>Enables or disables IPv6 protocol for management interfaces of all devices in the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAIPv6</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAIPv6 cmdlet enables or disables IPv6 protocol for management interfaces of all devices in the enclosure. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAIPv6</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para> Valid values are Enable | Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAIPv6 requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAIPv6 -Connection $connection -State Enable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOAIPv6 -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State: Disable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAIPv6 -State Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAIPv6DynamicDNS</command:name> <maml:description> <maml:para>Enables or disables dynamic DNS using IPv6 for either the specified bay or the active or standby Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAIPv6DynamicDNS</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAIPv6DynamicDNS cmdlet enables or disables dynamic DNS using IPv6 for the specified bay, active OA or standby OA. Dynamic DNS allows you to use a host name for the OA. The host name is registered with a DNS server. Dynamic DNS (DDNS) updates the DNS server with new or changed records for IP addresses. This enables you to use the same host name over time, although the dynamically assigned IP address might change. IPv6 Dynamic DNS requires that a valid DNS server(either IPv4 or IPv6) be configured on the Onboard Administrator.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAIPv6DynamicDNS</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para> Enables or disables dynamic DNS using IPv6. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para> Bay number or the Onboard Administrator where Dynamic DNS is to be enabled or disabled. Possible values are Active, Standby or the specific bay number for which Dynamic DNS is to be enabled/disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAIPv6DynamicDNS requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAIPv6DynamicDNS -Connection $connection -State Enable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOAIPv6DynamicDNS -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State: Disable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAIPv6DynamicDNS -State Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOALDAP</command:name> <maml:description> <maml:para>Enables or disables directory authentication.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOALDAP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOALDAP cmdlet enables or disables directory authentication. Before you can enable LDAP, configuration must be complete.</maml:para> <maml:para>NOTE. If LDAP is enabled, local accounts are disabled, and the LDAP server becomes unavailable, you can recover by booting into Lost Password mode. When booting in Lost Password mode, the local Administrator password will be reset, LDAP is disabled, and Local Logins are re-enabled.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOALDAP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>LocalUser</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables LDAP. Possible values are Enable and Disable. If you use the Disable option, local users are not enabled. So the value of Local user is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>LocalUser</maml:name> <maml:description> <maml:para> Possible values are Enable and Disable. If you use the Disable option, local users are not enabled. So the value of Local user is not required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOALDAP requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS C:\> Set-HPEOALDAP -Connection $connection -State Enable -LocalUser Enable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with State and LocalUser.</maml: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:\> Set-HPEOALDAP -Connection $connection -LocalUser Enable State not provided... Use same State for all Connections? (y/n): y Please enter State: Enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOALDAP -LocalUser Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOALDAPSetting</command:name> <maml:description> <maml:para>Sets the LDAP settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOALDAPSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOALDAPSetting cmdlet modifies the following LDAP settings: Group Access Level, Group Description, Group Name Map, Global Catalog Port, Port, LDAP Search, LDAP Server. For LDAP search, this cmdlet sets up to six search contexts in priority order. For LDAP Server, this cmdlet sets the IP address or the DNS name of the LDAP server for authentication.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet. Additionally, use the Add-HPEOAUserPrivilege cmdlet to give a user or group rights to the Onboard Administrator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOALDAPSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Group</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Access</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Description</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>NameMapping</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>GCPort</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Port</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SearchPriority</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SearchContent</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Server</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Group</maml:name> <maml:description> <maml:para>LDAP group name for which access is to be set. Group name must be 1 to 255 characters in length. Character set includes all printable characters, except quotation marks and new lines. The group name must start with an alpha character. Possible values are All or a specific group name can be specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Access</maml:name> <maml:description> <maml:para>Possible values are Administrator, Operator, and User. This is the access level assigned to the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>- Must be 0 to 58 characters in length. Valid characters are all alphanumeric, the underscore (_), the dash (-), and spaces. If the group name or description field contains spaces or zero characters, use double quotes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>NameMapping</maml:name> <maml:description> <maml:para>Enables or disables NT name mapping. Possible values are On and Off. Turns on NT name mapping to enable the user to enter their NT domain\username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>GCPort</maml:name> <maml:description> <maml:para>Sets the TCP port number of the LDAP Global Catalog SSL service. Port 3269 is the standard value. Possible values are <port number> or None.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the LDAP port value. Sets the TCP port number of the LDAP SSL service. Port 636 is the standard value. The valid port number range is 1 to 65535.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SearchPriority</maml:name> <maml:description> <maml:para>Priority of the search context. Possible values are numbers from 1 to 6.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SearchContent</maml:name> <maml:description> <maml:para>Specifies the search content.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Server</maml:name> <maml:description> <maml:para>Possible values are the IP address, DNS name or the string 'None'. IP address specifies the IP address of the LDAP server used for authentication. This is in the form ###.###.###.###, where each ### is in the range 0 to 255. DNS name specifies the DNS name for the LDAP server. 'None' is used to set the LDAP server field to blank.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOALDAPSetting requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOALDAPSetting -Connection $connection -Group Ben -Access Administrator -Description adminUser -NameMapping On -GCPort 108 -Port 280 -SearchPriority 5 -SearchContent xxxx</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Group, Access, Description, NameMapping, GCPort, Port, SearchPriority, and SearchContent.</maml: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:\> $connection | Set-HPEOALDAPSetting -Group Ben -Access Administrator -Description adminUser -NameMapping On -GCPort 108 -Port 280 -SearchPriority 5 -SearchContent xxxx</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOALLF</command:name> <maml:description> <maml:para>Enables or disables Link Loss Failover for Onboard Administrator Redundancy and modifies the LLF interval.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOALLF</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOALLF cmdlet enables or disables Link Loss Failover for Onboard Administrator Redundancy and modifies the LLF interval.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA Operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOALLF</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Interval</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables LLF for the onboard administrator. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Interval</maml:name> <maml:description> <maml:para>Value specified in seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOALLF requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOALLF - -Connection $connection -State Disable –Interval 100</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with State and Interval.</maml: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:\> $connection | Set-HPEOALLF -State Disable –Interval 100</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOALoginBanner</command:name> <maml:description> <maml:para>Enables or disables the display of the configured login banner when the user attempts to log in to the Onboard Administrator and also modifies the banner text.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOALoginBanner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOALoginBanner cmdlet enables or disables the display of the configured login banner when the user attempts to log in to the Onboard Administrator and also modifies the banner text.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOALoginBanner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>BannerText</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables the display of banner text. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>BannerText</maml:name> <maml:description> <maml:para>Text to be displayed on the login banner. The minimum length of the banner text must be one character and the banner text cannot exceed 1500 characters. The command accepts English (ASCII) characters only. The characters '%' and '\' are not permitted as part of the banner text itself. The banner text must contain at least one visible character. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOALoginBanner requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOALoginBanner -Connection $connection -State Enable -BannerText $bannertext </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter along with State and BannerText.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOALoginBanner -State Disable </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAMinimumPasswordLength</command:name> <maml:description> <maml:para>Sets a minimum length for passwords.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAMinimumPasswordLength</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAMinimumPasswordLength cmdlet sets a minimum length for passwords. When set, a user password must contain at least the number of characters specified.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAMinimumPasswordLength</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Length</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Length</maml:name> <maml:description> <maml:para>The minimum password length can be set between 3 and 40 characters. In FIPS Mode ON/DEBUG, the minimum password length can be set between 8 and 40 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAMinimumPasswordLength requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAMinimumPasswordLength -Connection $connection -Length 5</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Length.</maml: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:\> Set-HPEOAMinimumPasswordLength -Connection $connection Length not provided... Use same Length for all Connections? (y/n): y Please enter Length: 6 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Length parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAMinimumPasswordLength -Length 5</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAName</command:name> <maml:description> <maml:para>Sets the Onboard Administrator name.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAName cmdlet sets the Onboard Administrator name.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the Onboard Administrator for which name is being set. Valid values are 'Active' or the integer bay number of the Onboard Administrator. If a bay number is not specified, the command defaults to the active Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>The Onboard Administrator name is 1 to 32 characters long and can include all alphanumeric characters and the dash (-).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAName requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAName -Connection $connection -Bay 1 -Name SouthKing</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Bay and Name.</maml: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:\> Set-HPEOAName -Connection $connection -Bay 1 Name not provided... Use same Name for all Connections? (y/n): y Please enter Name: northwind </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Name parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAName -Bay 1 -Name SouthKing</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOANIC</command:name> <maml:description> <maml:para>Configures the external NIC for Auto-negotiation or forced link settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOANIC</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOANIC cmdlet configures the external NIC for Auto-negotiation or forced link settings.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOANIC</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>LinkSetting</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Speed</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>LinkSetting</maml:name> <maml:description> <maml:para>Link setting for external NIC. Possible values are Auto and Forced. Auto sets the link setting to Auto-negotiation. If value is set to Auto, then values for Bay and Speed parameters are not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>OA Bay number for which the NIC settings are to be modified. This is a required parameter when LinkSetting is set as Forced.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Speed</maml:name> <maml:description> <maml:para>Specifies the forced speed setting for the NIC when the LinkSetting is set to 'Forced'. Valid Values are 10 or 100Mbit. This is a required parameter when LinkSetting is set as 'Forced'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOANIC requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOANIC -Connection $connection -LinkSetting Forced -Bay 1 -Speed 100</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with LinkSetting, Bay, and Speed.</maml: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:\> Set-HPEOANIC -Connection $connection -Bay 1 -Speed 100 LinkSetting not provided... Use same LinkSetting for all Connections? (y/n): y Please enter LinkSetting: Forced </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the LinkSetting parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOANIC -LinkSetting Forced -Bay 1 -Speed 100</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOANTP</command:name> <maml:description> <maml:para>Enables or disables NTP support for the Onboard Administrator. This cmdlet also sets the polling interval of the NTP servers and the primary and secondary servers for synchronizing time and date using the NTP.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOANTP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOANTP cmdlet enables or disables NTP support for the Onboard Administrator. This cmdlet also sets the polling interval of the NTP servers and the primary and secondary servers for synchronizing time and date using the NTP.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOANTP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PollInterval</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PrimaryHost</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SecondaryHost</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enable or disable NTP. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PollInterval</maml:name> <maml:description> <maml:para>Poll time should be between 60 and 86,400 seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>PrimaryHost</maml:name> <maml:description> <maml:para>Primary server used for synchronizing time and date using NTP. The value can be an IPv4 address, an IPv6 address, or a DNS name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>SecondaryHost</maml:name> <maml:description> <maml:para>Secondary server used for synchronizing time and date using NTP. The value can be an IPv4 address, an IPv6 address, or a DNS name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOANTP requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOANTP -Connection $connection -State Enable -PollInterval 100 -PrimaryHost 192.168.243.68 -SecondaryHost 192.168.243.69</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with State, PollInterval, PrimaryHost, and SecondaryHost.</maml: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:\> Set-HPEOANIC -Connection $connection -Bay 1 -Speed 100 LinkSetting not provided... Use same LinkSetting for all Connections? (y/n): y Please enter LinkSetting: Forced </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the LinkSetting parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOANTP -State Enable -PollInterval 100 -PrimaryHost 192.168.243.68 -SecondaryHost 192.168.243.69</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAPassword</command:name> <maml:description> <maml:para>Sets the password for the user executing the command.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAPassword</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAPassword cmdlet sets the password for the user executing the command.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Password</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>The <password> must be three to eight characters long for firmware 1.00 through 1.30 and 3 to 40 characters long for firmware 2.00 and later. The character set includes all printable characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAPassword requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAPassword -Connection $connection -Password Admin</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Password.</maml: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:\> Set-HPEOAPassword -Connection $connection Password not provided... Use same Password for all Connections? (y/n): y Please enter Password: Admin </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Password parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAPassword -Password Admin</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAPower</command:name> <maml:description> <maml:para>Sets the power on the specified bay device.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>CAUTION. The Set-HPEOAPower command can cause a server blade to lose data or become unstable.</maml:para> <maml:para>The Set-HPEOAPower cmdlet sets the power on the specified bay device. It powers on or performs a graceful shutdown of the server or interconnect in the specified bay.</maml:para> <maml:para>The Set-HPEOAPower command returns the user to the CLI immediately but the shutdown actions can take up to 5 minutes to complete. Adding an optional boot argument forces the server blade to abandon the regular boot order and boot using the specified method. You must have access to the specified bay number. This command is not applicable to storage blades.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA Administrator or OA Operator having bay specific access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Power</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>BootOrder</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>ApplyNow</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Identifies the target device type for which the power is to be switched on or off. Possible values are Server and Interconnect. If the value is set to Interconnect, then the values for ApplyNow or BootOrder parameters is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Power</maml:name> <maml:description> <maml:para>Power setting to apply on the specified target device. Possible values are On or Off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the target device(s) for which the power is switched on or off. All or specific bay number(s) can be specified using All | <bay number> [,|- <bay number>].</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>Boot order for the target device when the Power parameter is set to On. Possible values are Normal, PXE, HDD and RBSU. This parameter is used only if the Power parameter is set to On. Forces the server blade to abandon the regular boot order and boot using the specified method.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>ApplyNow</maml:name> <maml:description> <maml:para>Switch parameter. If it is present, the server blade is immediately shut down and might lose data or become unstable.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAPower requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAPower -Connection $connection -Target Server -Power On -Bay 1 -BootOrder HDD</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Target, Power, Bay, and BootOrder.</maml: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:\> Set-HPEOAPower -Connection $connection -BootOrder HDD Target not provided... Use same Target for all Connections? (y/n): y Please enter Target: Server Power not provided... Use same Power for all Connections? (y/n): y Please enter Power: On Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 1 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Target, Power, and Bay parameters are not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAPower -Target Server -Power On -Bay 1 -BootOrder HDD </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAPowerDelay</command:name> <maml:description> <maml:para>Sets the PowerDelay status for the specified server or range of servers or for specified interconnect or range of interconnects.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAPowerDelay</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAPower cmdlet sets the PowerDelay status for the specified server or range of servers or for specified interconnect or range of interconnects.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA Administrator having bay specific access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAPowerDelay</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Delay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Identifies the target device type(s) for which power delay setting have to be modified. Possible values are Interconnect and Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the target device(s) for which Power Delay is being set. Possible values can be specified as All | <bay number> [,|- <bay number>].</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Delay</maml:name> <maml:description> <maml:para>Power delay specified in seconds. If set to zero, the delay has no effect on the device. Possible value can be specified as <delay> or NoPowerOn. If the delay is NoPowerOn, the device cannot power on until all devices have completed their delays.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAPowerDelay requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAPowerDelay -Connection $connection -Target Server -Bay 1 -Delay 250</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Target, Bay, and Delay.</maml: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:\> Set-HPEOAPowerDelay -Connection $connection Target not provided... Use same Target for all Connections? (y/n): y Please enter Target: Interconnect Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 1 Delay not provided... Use same Delay for all Connections? (y/n): y Please enter Delay: 300 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Target,Bay and Delay parameters are not provided, you are prompted to input the values.</maml: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:\> $connection | Set-HPEOAPowerDelay -Target Server -Bay 1 -Delay 250</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAPowerSetting</command:name> <maml:description> <maml:para>Configures power supply redundancy settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAPowerSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAPowerSetting cmdlet configures power supply redundancy settings.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA Administrator or OA Operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAPowerSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Mode</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Limit</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Saving</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Mode</maml:name> <maml:description> <maml:para>The following are valid settings: - NotRedundant: This setting enables all power supplies to function without regard for redundancy. - PowerSupply: This setting enables one power supply to fail without being over committed on power. - Redundant: This setting enables half of the power supplies to fail without being over committed on power.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the limit on how much input power can be consumed by the enclosure. This setting is useful if the enclosure receives power from a PDU with a limited power rating.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Saving</maml:name> <maml:description> <maml:para>Turns power savings mode on or off. Power savings mode turns unneeded power supplies off. The increased load on the remaining power supplies increases their efficiency, resulting in less power consumption. The power savings mode is not supported for low voltage on the c7000 enclosure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAPowerSetting requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAPowerSetting -Connection $connection -Mode PowerSupply -Limit 5000 -Saving On</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Mode, Limit, and Saving.</maml: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:\> $connection | Set-HPEOAPowerSetting -Connection -Mode PowerSupply -Limit 5000 -Saving On</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOARackName</command:name> <maml:description> <maml:para>Sets the rack name.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOARackName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOARackName cmdlet sets the rack name. A list of connection objects must be provided as a parameter. OA Administrator or OA Operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOARackName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>RackName</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>RackName</maml:name> <maml:description> <maml:para>The <rack name> must be a maximum of 32 characters long and includes all alphanumeric, the dash, and the underscore characters. UnnamedRack is the default rack name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>UnnamedRack</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOARackName requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOARackName -Connection $connection -RackName SouthKing</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with RackName.</maml: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:\> Set-HPEOARackName -Connection $connection RackName not provided... Use same RackName for all Connections? (y/n): y Please enter RackName: SouthKing </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the RackName parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOARackName -RackName</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOARemoteSupport</command:name> <maml:description> <maml:para>Registers or unregisters the Onboard Administrator with the IRS/aggregator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOARemoteSupport</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOARemoteSupport cmdlet registers or unregisters the Onboard Administrator with the IRS/aggregator.</maml:para> <maml:para>Registering allows the enclosure to communicate to HP through an HP Insight Remote Support centralized Hosting Device in your local environment. After the registration or unregistration, you can use the Test-HPEOARemoteSupport to send a test event to check the connection between the OA and IRS.</maml:para> <maml:para>For registering for remote support: Insight Remote Support 7.0.5 or later must be installed and configured on the Insight Remote Support centralized hosting device. Version 3.60 or later of the Onboard Administrator firmware must be installed. A valid certificate is required if connecting to an HP Insight Remote Support Hosting Device and the Onboard Administrator is operating in FIPS Mode</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA Administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOARemoteSupport</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Host</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Port</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables(registers) or disables(unregisters) Remote support. Possible values are Enable and Disable. If the value is set to Disable, then the values for Host and Port are not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Host</maml:name> <maml:description> <maml:para>IP address or Host name for the IRS/aggregator for Remote Support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para>Port number where the Onboard Administrator interacts with the IRS server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOARemoteSupport requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOARemoteSupport -Connection $connection -State Enable -Host 192.168.243.56 -Port 7906</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State, Host, and Port. Host name and Port number are specified for the local IRS hosting device. The enclosure is registered (using 'Enable' in State parameter) for remote support.</maml: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:\> Set-HPEOARemoteSupport -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State (Acceptable values are Enable, Disable): Disable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection |Set-HPEOARemoteSupport -State Enable -Host 192.168.243.56 -Port 7906</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOARemoteSupportDirect</command:name> <maml:description> <maml:para>Sets Remote Support proxy settings, registers, or unregisters the Onboard Administrator enclosure for Remote Support Direct Connect (DIRECT mode).</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOARemoteSupportDirect</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOARemoteSupportDirect cmdlet sets Remote Support proxy settings, registers, or unregisters the Onboard Administrator enclosure for Remote Support Direct Connect (DIRECT mode).</maml:para> <maml:para>Registering Remote Support Direct Connect allows the enclosure to communicate directly to HP without the need to set up an HP Insight Remote Support centralized Hosting Device in your local environment. After entering the command, you are asked to confirm that you agree to have Insight Remote Support send data to HP and that you agree to the terms and conditions of the HP Software License Agreement and the HP Insight Management Additional License Authorization (located at the HP website (http://www.hp.com/go/SWLicensing)).</maml:para> <maml:para>Before registering Remote Support Direct Connect, it may be required to set Remote Support proxy settings if the Onboard Administrator enclosure uses a proxy server to access the Internet. Proxy settings must be kept up to date to enable your c-Class enclosure to continue to send remote support data to HP. The Direct Connect Remote Support configuration is available in Onboard Administrator 4.11 and later.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA Administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOARemoteSupportDirect</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Password</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ProxyServer</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ProxyPort</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ProxyUsername</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ProxyPassword</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>ConfirmLicense</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>CompleteRegistration</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables(registers) or disables(Unregisters) Remote Support Direct Connect. Possible values are Enable and Disable. If the value is set to Disable, then the values for Username and Password parameters are not required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>HP Passport Username. It is required if State value is Enable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>HP Passport Password. It is required if State value is Enable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server IP address or Hostname. Possible values are 'None', IP or Hostname of the Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port number used to interact with Proxy Server. Value is Integer only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ProxyUsername</maml:name> <maml:description> <maml:para>Username used to interact with Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ProxyPassword</maml:name> <maml:description> <maml:para>Password used to interact with Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>ConfirmLicense</maml:name> <maml:description> <maml:para>Switch parameter to confirm the license agreements in step 1 of HP Remote Support Direct Connect. If this parameter is not specified when State value is Enable with Username and Password provided, you will be asked to confirm that you agree to have Insight Remote Support send data to HP and that you agree to the terms and conditions of the HP Software License Agreement and the HP Insight Management Additional License Authorization (located at the HP website (http://www.hp.com/go/SWLicensing)), otherwise, all the license agreements will be accepted automatically.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>CompleteRegistration</maml:name> <maml:description> <maml:para>– Switch parameter to confirm you have completed registration in HP Insight Online. If this parameter is specified, the second step of finishing registerting for Insight Remote Support through a direct connection to HP Insight Online will be performed, otherwise, it will only execute the first step of registering even if the State value is Enable with Username and Password provided.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOARemoteSupportDirect requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOARemoteSupportDirect -Connection $connection -State Enable -Username userA -Password passwordA -ProxyServer proxy.company.com -ProxyPort 8080 -ConfirmLicense -CompleteRegistration </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State, Username, Password, ProxyServer, ProxyPort, ConfirmLicense and CompleteRegistration. Because ProxyServer and ProxyPort are provided, the command will set the proxy server settings before registering HP Remote Support Direct Connect. As ConfirmLicense and CompleteRegistration are specified, the command will accept all the license agreements and complete HP Insight Online registration automatically. </maml: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:\> Set-HPEOARemoteSupportDirect -Connection $connection -State Enable -Username userA -Password passwordA Please confirm the license agreement for 192.168.241.254: By registering, A. You agree to have Insight Remote Support send Registration, Service Events, and Configuration data to HP. For more information on the type of data collected, see the Onboard Administrator User Guide. All data collected and sent to HP will be managed according to the HP Data Privacy Policy located at www.hp.com/go/privacy B. You accept the terms and conditions of the HP Software License Agreement and the HP Insight Management Additional License Authorization located at www.hp.com/go/SWLicensing Entering anything other than 'YES' will not enable Remote Support Direct Connect. Do you want to accept all the license agreement for 192.168.241.254?: yes IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.241.254 northwind.company.net Warning ACTION REQUIRED: Step 2 of 2, HP Insight ... </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the ConfirmLicense parameter is not provided, you are asked to confirm the license agreement. As CompleteRegistration parameter is not provided, the command will not execute step 2 of confirming HP Insight Online registration process complete. The final StatusType is warning to ask you to finish step 2. .</maml: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:\> Set-HPEOARemoteSupportDirect -Connection $connection -CompleteRegistration </dev:code> <dev:remarks> <maml:para>In this example CompleteRegistration is provided without State parameter. Command will only execute step 2 of confirming HP Insight Online registration process complete. Make sure you have already performed step 1 of registering before this usage. </maml: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>PS C:\> $connection | Set-HPEOARemoteSupportDirect -State Disable IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.241.254 northwind.company.net Warning Un-registration in progress, please wait ... </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. Since unregistering HP Remote_Support needs up to 5 minutes for the request to be fully processed, the returned StatusType is always 'warning' when disabling Remote Support Direct Connect.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOARemoteSupportMaintenance</command:name> <maml:description> <maml:para>Enables or disables the Remote Support maintenance window.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOARemoteSupportMaintenance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOARemoteSupportMaintenance cmdlet enables or disables the Remote Support maintenance window. Remote Support must be enabled before running Set-HPEOARemoteSupportMaintenance. This setting is not recorded when you run the Get-HPEOAConfig command.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA Administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOARemoteSupportMaintenance</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>IntervalType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Interval</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables remote support maintenance. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>IntervalType</maml:name> <maml:description> <maml:para>Unit of time for time interval for which remote support maintenance window is started. Possible values are Min, Hour, Day, and Week.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Interval</maml:name> <maml:description> <maml:para>Time interval for which Remote Support is enabled and the maintenance window is started.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOARemoteSupportMaintenance requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOARemoteSupportMaintenance -Connection $connection -State Enable -IntervalType Day -Interval 1 </dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as a parameter along with State, IntervalType, and Interval.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOARemoteSupportMaintenance -State Disable </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOARemoteSyslog</command:name> <maml:description> <maml:para>Sets the IP port number and IP address (or DNS name) for remote system log.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOARemoteSyslog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOARemoteSyslog cmdlet sets the IP port number and IP address (or DNS name) for remote system log. Setting the remote port is optional. If the remote port is not set, then the default UDP port 514 is used to send system log messages.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOARemoteSyslog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Port</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Server</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Port</maml:name> <maml:description> <maml:para>The remote port must be an integer between 1 and 65535 inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Server</maml:name> <maml:description> <maml:para>IP address or DNS name for remote system log messages. Can be specified as <IPv4>|<IPv6>|<DNS name>. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOARemoteSyslog requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOARemoteSyslog -Connection $connection -Server 192.168.243.56 -Port 266</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Server and Port.</maml: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:\> $connection |Set-HPEOARemoteSyslog -Server 192.168.243.56 -Port 266</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAGUILoginDetail</command:name> <maml:description> <maml:para>Enables or disables extended enclosure information available in the GUI on the login page.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAGUILoginDetail</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAGUILoginDetail cmdlet enables or disables extended enclosure information available in the GUI on the login page. A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAGUILoginDetail</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enable or Disable extended enclosure information in GUI on login page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAGUILoginDetail requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAGUILoginDetail -Connection $connection –State $state</dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as parameters along with State.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAGUILoginDetail -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State (Acceptable values are Enable,Disable): Enable </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided for the OAs, you are asked to input the value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $server | Set-HPEOAGUILoginDetail</dev:code> <dev:remarks> <maml:para>This example shows $server containing connection and state infomation is passed as parameter to the cmdlet through pipeline. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOASerialBaud</command:name> <maml:description> <maml:para>Configures the baud rate settings for the Onboard Administrator serial console port.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOASerialBaud</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOASerialBaud cmdlet configures the baud rate settings for the Onboard Administrator serial console port.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet. The cmdlet is not available on OA3.x.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOASerialBaud</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>BaudRate</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>BaudRate</maml:name> <maml:description> <maml:para>Baud rate value for the Onboard Administrator serial console port. Possible values are 9600, 19200, 38400, 57600, and 115200.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOASerialBaud requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOASerialBaud -Connection $connection –BaudRate $baudrate</dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as parameters along with BaudRate.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOASerialBaud -Connection $connection BaudRate not provided... Use same BaudRate for all Connections? (y/n): y Please enter BaudRate (Acceptable values are 9600,19200,38400,57600,115200): 9600 </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Parameter BaudRate is not input, you are asked to input the values.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $server | Set-HPEOASerialBaud</dev:code> <dev:remarks> <maml:para>This example shows $server containing Connection, BaudRate infomation is passed as parameter to the cmdlet through pipeline. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOARouterAdvertisement</command:name> <maml:description> <maml:para>Enables or disables auto-configuration of IPv6 addresses from Router Advertisement messages.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOARouterAdvertisement</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOARouterAdvertisement cmdlet enables or disables auto-configuration of IPv6 addresses from Router Advertisement messages. For OA FW v3.11/3.32, it will operate on the specified bay. For OA FW3.60, it will operate on all OA, interconnect and server iLO modules in the enclosure.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOARouterAdvertisement</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables router advertisement. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the Onboard Administrator. If bay number is not specified, the command will default to the active Onboard Administrator. It is only supported on OA FW v3.11 and v3.32.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOARouterAdvertisement requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOARouterAdvertisement -Connection $connection -State $state </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> Set-HPEOARouterAdvertisement -Connection $connection State not provided... Use same State for all Connections? (y/n): n Please enter State for 192.168.242.62: disable Please enter State for 192.168.242.63: enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the parameter State is not input, you are prompted to input the values.</maml: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:\> $server | Set-HPEOARouterAdvertisement </dev:code> <dev:remarks> <maml:para>In this example $server containing connection and state information is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOASecureSh</command:name> <maml:description> <maml:para>Enables or disables SSH support for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOASecureSh</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOASecureSh cmdlet enables or disables Secure Shell support for the OA and also used to set the insecure diffie-hellman-group-1 sha1 key exchange on the OA’s SSH server. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> <maml:para>Warning: The connection will be disconnected when you disable Secure Shell. You have to enable it through Web page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOASecureSh</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DHG1KeyExchange</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enable or Disable the Secure Shell support for the Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DHG1KeyExchange</maml:name> <maml:description> <maml:para>Enable or disable insecure Diffie-hellman-group 1-sha1 key exchange on the Onboard Administrator’s SSH server. Possible values are Enable or Disable. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOASecureSh requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOASecureSh -Connection $connection -State Enable -DHG1KeyExchange Enable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with State and DHG1KeyExchange.</maml: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:\> $connection |Set-HPEOASecureSh -State Enable -DHG1KeyExchange Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAServerBootOrder</command:name> <maml:description> <maml:para>Sets the onetime and permanent boot order setting for the IPL.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAServerBootOrder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAServerBootOrder cmdlet sets the onetime or permanent boot order of the specified blade(s). The cmdlet stores a setting for the IPL to be passed to the servers specified at the next reboot(Onetime) or it sets the first boot device from next boot onward(Permanent). You must have access to the specified bay number. </maml:para> <maml:para>This command is not applicable to storage blades. This command is not applicable to HP Integrity server blades. This setting is only valid on present blades and cleared if the blade is removed.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator having bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAServerBootOrder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>BootType</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>BootOrder</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>BootType</maml:name> <maml:description> <maml:para>Onetime or Permanent boot order setting. Allowed values are 'Onetime' or 'Once' for onetime boot order setting and 'Permanent' or 'First' for permanent boot order setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>Identifies boot device to be used on the next boot or on the permanent boot order. Possible values for OA3.x are Normal, HDD, PXE and RBSU; Possible values for OA 4.x are Normal, CD, HDD, PXE, USB, RBSU and Floppy. USB option is only available if BootType is set to Permanent and the OA firmware version is 4.00 and later. RBSU or Normal options are only available if BootType is set to OneTime. CD and Floppy are valid BootOrder values for OA firmware 4.00 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the server for which the boot order is being set. Possible values are specified as All or %lt;bay number> [,|- <bay number>]).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAServerBootOrder requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAServerBootOrder -Connection $connection -BootType $boottype -BootOrder $bootorder -Bay $bay </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with BootType, BootOrder, and Bay.</maml: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:\> Set-HPEOAServerBootOrder -Connection $connection BootType not provided... Use same BootType for all Connections? (y/n): y Please enter BootType: once BootOrder not provided... Use same BootOrder for all Connections? (y/n): n Please enter BootOrder for 192.168.242.62: hdd Please enter BootOrder for 192.168.242.63: pxe Bay not provided... Use same Bay for all Connections? (y/n): n Please enter Bay for 192.168.242.62: 1 Please enter Bay for 192.168.242.63: 3 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters BootType, BootOrder, and Bay are not provided, you are prompted to input the values.</maml: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:\> $server | Set-HPEOAServerBootOrder </dev:code> <dev:remarks> <maml:para>In this example $server containing Connection, BootType, BootOrder, and Bay information is passed as parameter to the cmdlet through pipeline. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAServerDVD</command:name> <maml:description> <maml:para>Connects or disconnects the specified server or range of servers from the enclosure DVD drive.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAServerDVD</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAServerDVD cmdlet connects or disconnects the specified server or range of servers from the enclosure DVD drive. You must have access to the specified bay number. Different sides of the server bay cannot be designated within the same range.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator having bay specific access can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAServerDVD</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Disconnect</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the server(s) to connect or disconnect the enclosure DVD drive. Possible values are specified as All or <bay number> [,|- <bay number>]).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>URL to the ISO images present on the enclosure USB media.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Disconnect</maml:name> <maml:description> <maml:para>Disconnects the specified server(s) from the enclosure DVD drive. If this parameter is not specified, the specified bays will be connected to the enclosure DVD drive.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAServerDVD requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAServerDVD -Connection $connection –Bay 2 –URL usb://d1/fw930.iso</dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as parameters along with Bay and URL.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAServerDVD -Connection $connection –Bay 2 –Disconnect</dev:code> <dev:remarks> <maml:para>This example shows that the list of OA connection is passed as parameters along with Bay and Disconnect.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAServerDVD -Connection $connection –URL usb://d1/fw930.iso Bayfee not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 2 </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Bay parameter is not provided for the OAs, you are asked to input the value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAServerDVD –Bay 2 –URL usb://d1/fw930.iso </dev:code> <dev:remarks> <maml:para>This example shows $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOASessionTimeout</command:name> <maml:description> <maml:para>Sets the number of minutes before inactive sessions are removed.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOASessionTimeout</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOASessionTimeout cmdlet sets the number of minutes before inactive sessions are removed.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOASessionTimeout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Timeout</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Valid session timeout values range from 10 to 1440 minutes (24 hours). The default setting is 1440.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1440</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOASessionTimeout requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOASessionTimeout -Connection $connection -Timeout 1000</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Timeout.</maml: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:\> Set-HPEOASessionTimeout -Connection $connection Timeout not provided... Use same Timeout for all Connections? (y/n): y Please enter Timeout: 200 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Timeout parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOASessionTimeout -Timeout 1000</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOASLAAC</command:name> <maml:description> <maml:para>Enables or disables the auto-configuration of IPv6 addresses from SLAAC messages.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOASLAAC</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOASLAAC cmdlet enables or disables the auto-configuration of IPv6 addresses from SLAAC messages.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOASLAAC</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables the auto-configuration of IPv6 addresses from SLAAC messages for management interfaces of all devices in the enclosure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOASLAAC requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOASLAAC -Connection $connection -State Enable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOASLAAC -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State (Acceptable values are Enable, Disable): Enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOASLAAC -State Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOASNMP</command:name> <maml:description> <maml:para>Enables or disables SNMP and modifies SNMP settings.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOASNMP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOASNMP cmdlet enables or disables SNMP Trap support for the Onboard Administrator and sets SNMP community, contact, EngineId and location. You cannot use is command in FIPS Mode ON/DEBUG. Default SNMP contact is blank.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOASNMP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Type</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>CommunityName</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Contact</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineId</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Location</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables SNMP trap support for the Onboard Administrator. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Read or Write type of trap community. Value for CommunityName parameter is required if Type is set as Read or Write.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>CommunityName</maml:name> <maml:description> <maml:para>If a blank write community name is given, SNMP set commands are disabled until a non-empty community name is given. The <communityname> must be 0 to 20 characters long. All printable characters are valid.Value for Type parameter is required if CommunintyName value is provided.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Contact</maml:name> <maml:description> <maml:para>The <contact> must be no more than 20 characters long. Valid characters are all alphanumeric, the underscore (_), the dash (-), and spaces.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>EngineId</maml:name> <maml:description> <maml:para>Sets the SNMPv3 engine ID for the enclosure. The final engine ID will be a hexadecimal string derived from the <engineID> value. The <engineID> must be between 1 and 27 characters in length. The final engine ID will be a hexadecimal string derived from this value. Any local users must be deleted and recreated after changing the local engine ID. The parameter is only support on OA FW 4.11.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>The <location> must be no more than 20 characters long. Valid characters are all alphanumeric, the underscore (_), the dash (-), and spaces. The default location is blank.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOASNMP requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOASNMP -Connection $connection -State $state -Type $type -CommunityName $communityname -Contact $contact -Location $location </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State, Type, CommunityName, Contact, and Location. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection | Set-HPEOASNMP -State $state -Type $type -CommunityName $communityname -Contact $contact -Location $location </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAStrongPassword</command:name> <maml:description> <maml:para>Enables or disables strong password requirements for user passwords.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAStrongPassword</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAStrongPassword cmdlet enables or disables strong password requirements for user passwords. When enabled, this command requires that a user's password contain at least one character from three of the four categories, which include the following: - Uppercase - Lowercase - Numeric - Non-alphanumeric</maml:para> <maml:para>A list of connection objects must be provided as a parameter. Only Administrators with Onboard Administrator permission are allowed to manage strong passwords. Strong passwords are enabled by default in FIPS Mode ON/DEBUG.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAStrongPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables strong password. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAStrongPassword requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAStrongPassword -Connection $connection -State Enable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOAStrongPassword -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State (Acceptable values are Enable, Disable): Disable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection |Set-HPEOAStrongPassword -Connection -State Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOASysLogRemote</command:name> <maml:description> <maml:para>Enables or disables remote system logging.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOASysLogRemote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOASysLogRemote cmdlet enables or disables remote system logging.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOASysLogRemote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables remote system logging. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOASysLogRemote requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOASysLogRemote -Connection $connection -State Enable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOASysLogRemote -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State (Acceptable values are Enable, Disable): Enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOASysLogRemote -State Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOATelnet</command:name> <maml:description> <maml:para>Enables or disables telnet access to the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOATelnet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOATelnet cmdlet enables or disables telnet access to the Onboard Administrator. You cannot enable TELNET in FIPS Mode ON/DEBUG.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOATelnet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables telnet access on the Onboard Administrator. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOATelnet requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOATelnet -Connection $connection -State Enable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOATelnet -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State (Acceptable values are Enable, Disable): Enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOATelnet -State Enable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOATimezone</command:name> <maml:description> <maml:para>Sets the time zone.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOATimezone</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOATimezone cmdlet sets the time zone. Some time zones that are commonly used include: CET, CST6CDT, EET, EST, EST5EDT, GB, GMT, HST, MET, MST, MST7MDT, NZ, PRC, PST8PDT, UCT, and UTC.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOATimezone</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Timezone</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Timezone</maml:name> <maml:description> <maml:para>Timezone to be set on the Onboard Administrator. Refer to list of timezones in about_HPEOA_Timezones.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOATimezone requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOATimezone -Connection $connection -Timezone MST</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Timezone.</maml: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:\> Set-HPEOATimezone -Connection $connection Timezone not provided... Use same Timezone for all Connections? (y/n): y Please enter Timezone: MST </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Timezone is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOATimezone -Timezone MST</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOATrustedHost</command:name> <maml:description> <maml:para>Enables or disables IP security for the Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOATrustedHost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOATrustedHost cmdlet enables or disables IP security for the Onboard Administrator.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> <maml:para>Warning: Other clients might fail to connect to this OA after setting trusted host.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOATrustedHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables IP security for the Onboard Administrator. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOATrustedHost requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOATrustedHost -Connection $connection -State $state </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet along with State. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $server | Set-HPEOATrustedHost </dev:code> <dev:remarks> <maml:para>In this example $server containing connection and state information is passed as parameter to the cmdlet through pipeline.</maml: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:\> Set-HPEOATrustedHost -Connection $connection State not provided... Use same State for all Connections? (y/n): n Please enter State for 192.168.242.62: enable Please enter State for 192.168.242.64: disable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the parameter State is not input, you are prompted to input the values.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAUID</command:name> <maml:description> <maml:para>Sets the UID on or off for the Onboard Administrator, Interconnect, server, or enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAUID</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAUID cmdlet sets the UID on or off for the Onboard Administrator, Interconnect, server, or enclosure. All users can set the UID for an Onboard Administrator to on or off and all users with access to the specified bay can set the UID for interconnect or the server. For enclosure, OA administrator or OA operator can set the UID.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAUID</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>UIDControl</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target for which to set UID. Possible values are OA, Enclosure, Server and Interconnect. Bay Parameter is needed if Target is set as 'Server' or 'Interconnect' </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the Onboard Administrator, server, or Interconnect for which UID is being set. Bay can be specified as <bay number> | Active | Standby. If you do not specify a bay number, the command defaults to the active Onboard Administrator if OA is set as value for Target parameter. This value is required if Target is set as 'Server' or 'Interconnect'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>UIDControl</maml:name> <maml:description> <maml:para>UID value to be set for the specified target device(s). Possible values are On and Off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAUID requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAUID -Connection $connection -Target $target -UIDControl $uidcontrol </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> Set-HPEOAUID -Connection $connection -Bay $bay Target not provided... Use same Target for all Connections? (y/n): y Please enter Target: interconnect UIDControl not provided... Use same UIDControl for all Connections? (y/n): y Please enter UIDControl: on </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Target and UIDControl are not input, you are prompted to input the values.</maml: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:\> $server | Set-HPEOAUID -Bay $bay</dev:code> <dev:remarks> <maml:para>In this example $server containing Connection, Target, and UIDControl information is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAURB</command:name> <maml:description> <maml:para>Enables or disables URB reporting and modifies URB reporting setting.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAURB</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAURB cmdlet enables or disables URB reporting and modifies URB reporting setting. The URB URL and interval must be set before enabling URB reporting.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAURB</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Protocol"> <maml:name>EnableProtocol</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="URL"> <maml:name>HTTPURL</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Interval</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>ProxyURL</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>SMTPServer</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Mailbox</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Values are Enable | Disable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Protocol"> <maml:name>EnableProtocol</maml:name> <maml:description> <maml:para>Values are HTTP | SMTP | Both.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="URL"> <maml:name>HTTPURL</maml:name> <maml:description> <maml:para>Sets the URB endpoint URL. The URL must be either an HTTP or HTTPS URL and can be no longer than 128 characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Interval</maml:name> <maml:description> <maml:para>Sets the interval at which URB messages are sent. Values can be specified as Hourly, <minute> | Daily, <hour> | Weekly, <day>, <hour> | Monthly, <day>, <hour>. The minute parameter must be 0-59. The Daily hour parameter must be 0-23. The Weekly day parameter must be 1-7 where 1 is Sunday and 7 is Saturday. The Monthly day parameter must be 1-31.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>ProxyURL</maml:name> <maml:description> <maml:para>Sets the proxy URL to use when sending URB messages. The URL can be no longer than 128 characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>SMTPServer</maml:name> <maml:description> <maml:para>DNS of the SMTP server used to send URB report.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Mailbox</maml:name> <maml:description> <maml:para>Email to which URB report is sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAURB requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAURB -State Enable -EnableProtocol Both </dev:code> <dev:remarks> <maml:para>This example shows how to enable URB through both HTTP and SMTP. When State parameter is “Disable”, EnableProtocol is not necessary and will not be used. Since on earlier version of OA firmware, only HTTP is supported, so to enable URB on earlier OA versions, you can ignore the EnableProtocol parameter because no matter what value is provided it will be ignored.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAURB -HTTPURL "https://server-address/" </dev:code> <dev:remarks> <maml:para>This example shows how to set the http url for URB and it will be used when the enabled protocol is HTTP. </maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAURB -ProxyURL "https://proxy-address"" </dev:code> <dev:remarks> <maml:para>This example shows how to set proxy for URB.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAURB -Interval "Hourly 55"" </dev:code> <dev:remarks> <maml:para>This example shows how to set the interval at which Utility Ready Blade (URB) messages will be sent. It is a string containing the following format “HOURLY <minute> | DAILY <hour> | WEEKLY <day> <hour> | MONTHLY <day> <hour>”. The minutes parameter must be 0-59. The DAILY hour parameter must be 0-23. The WEEKLY day parameter must be 0-6 where 0 is Sunday and 6 is Saturday. The MONTHLY day parameter must be 1-31. </maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAURB -SMTPServer "smtp.xx.com" -Mailbox "name@xx.com"</dev:code> <dev:remarks> <maml:para>This example shows how to set SMTP server and Mailbox for URB. They are used when the enabled protocol is SMTP. These two parameters are supported on some later OA versions.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAURB -State Enable -EnableProtocol SMTP -HTTPURL https://server-address/ -Interval "Hourly 55" -ProxyURL http://proxy-address -SMTPServer smtp.xx.com -Mailbox name@xx.com</dev:code> <dev:remarks> <maml:para>This example shows how to set all the possible values regarding URB on a later OA version. </maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAURB -State Enable -HTTPURL https://server-address/ -Interval "Hourly 55" -ProxyURL http://proxy-address </dev:code> <dev:remarks> <maml:para>This example shows how to set all the possible values regarding URB on an earlier OA version (On earlier versions SMTP is not supported while only HTTP is supported). </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAUSB</command:name> <maml:description> <maml:para>Allows the Onboard Administrator to select which USB controller to enable.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAUSB</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAUSB cmdlet allows the Onboard Administrator to select which USB controller to enable.This command has no effect on c3000 Onboard Administrator boards that are hardware revision level 'CO' and later as displayed with Get-HPEOAInfo. A small number of c3000 Onboard Administrator boards can use only one USB controller at a time.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAUSB</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Controller</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Controller</maml:name> <maml:description> <maml:para>Values are Front | Back. The Front controller enables the internal DVD drive and the front USB connector. The Back controller enables the two USB ports on the rear of the KVM Option Module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAUSB requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAUSB -Connection $connection -Controller $controller </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlets along with Controller. It can be an Object or an Object array returned from Connect-HPEOA. </maml: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:\> Set-HPEOAUSB -Connection $connection Controller not provided... Use same Controller for all Connections? (y/n): y Please enter Controller: back </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the parameter Controller is not provided, you are prompted to input the value.</maml: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:\> $server | Set-HPEOAUSB</dev:code> <dev:remarks> <maml:para>In this example $server containing Connection and Controller information is passed as parameter to the cmdlet through pipeline. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAUser</command:name> <maml:description> <maml:para>Enables or disables a user account that was previously disabled by the Disable-HPEOAUser command and modifies user access level and other user information.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAUser cmdlet enables or disables a user account that was previously disabled by the Disable-HPEOAUser command and modifies user access level and other user information.</maml:para> <maml:para>Additionally, use the Add-HPEOABayUser command to give user access rights to the Onboard Administrator, server bays, and interconnect bays. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. A user can be enabled or disabled by an OA administrator only. A user which does not have OA administrator access will not be able to enable or disable a user or modify access levels. OA operator and OA user access level users can change their own passwords. OA administrators can modify all user's passwords.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Access</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ContactInfo</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>FullName</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>NewPassword</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>The Username is case sensitive. If no Username is provided along with ContactInfo or FullName, the command modifies the contact information or full name of the user who is currently logged in. (Optional when setting ContactInfo or FullName).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables the specified user. Possible values are Enable and Disable. (Optional when other parameters are provided along with Username.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Access</maml:name> <maml:description> <maml:para>Access level provided to the enabled user. Possible values are Administrator, Operator, and User. (Optional when other parameters are provided along with Username.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ContactInfo</maml:name> <maml:description> <maml:para>The contact info must be a maximum of 20 characters long and includes all alphanumeric characters, the dash, the underscore, and spaces. The default contact information is blank. You must use double quotes if the contact information contains any spaces. (Optional when other parameters are provided along with Username.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>FullName</maml:name> <maml:description> <maml:para>The full name must be a maximum of 20 characters long and includes all alphanumeric, the dash, the underscore, and the space characters. The default full name is blank. (Optional when other parameters are provided along with Username.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>The new password must be three to eight characters long for firmware 1.00 through 1.30 and 3 to 40 characters long for firmware 2.00 and higher. The character set includes all printable characters. (Optional when other parameters are provided along with Username.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAUser requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAUser -Connection $connection -Username user1 -NewPassword password_user1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Username and NewPassword.</maml: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:\> Set-HPEOAUser -Connection $connection -Username user1 -Access Administrator</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connection | Set-HPEOAUser -Username user1 -State Disable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAVLAN</command:name> <maml:description> <maml:para>Enables or disables VLAN on the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAVLAN</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAVLAN cmdlet enables or disables VLAN on the enclosure.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAVLAN</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enables or disables Virtual LAN on the enclosure. Possible values are Enable and Disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAVLAN requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAVLAN -Connection $connection -State Disable</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with State.</maml: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:\> Set-HPEOAVLAN -Connection $connection State not provided... Use same State for all Connections? (y/n): y Please enter State (Acceptable values are Enable, Disable): Enable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the State parameter is not provided, you are prompted to input the value.</maml: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:\> $connection | Set-HPEOAVLAN -State Disable</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAVLANDefault</command:name> <maml:description> <maml:para>Sets or changes the default VLAN ID for the enclosure.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAVLANDefault</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAVLANDefault cmdlet sets or changes the default VLAN ID for the enclosure. Devices using the current default are reassigned to the new ID.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAVLANDefault</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <maml:description> <maml:para>VLAN ID to be set to default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAVLANDefault requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANDefault -Connection $connection -VLANID 1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with VLANID.</maml: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:para> </maml:introduction> <dev:code> PS C:\> PS C:\> Set-HPEOAVLANDefault -Connection $connection VLANID not provided... Use same VLANID for all Connections? (y/n): y Please enter VLANID: 1 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the VLANID parameter is not provided for the OAs, you are asked to input the value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAVLANDefault -VLANID 1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAVLANFactoryDefault</command:name> <maml:description> <maml:para>Restores the VLAN settings to factory defaults.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAVLANFactoryDefault</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAVLANFactoryDefault cmdlet restores the VLAN settings to factory defaults. VLAN is disabled and all devices are grouped in VLAN ID 1. To execute the command, enter YES when asked if you are sure you want to restore VLAN settings to factory defaults.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAVLANFactoryDefault</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAVLANFactoryDefault requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANFactoryDefault -Connection $connection</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAVLANDefault</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAVLANID</command:name> <maml:description> <maml:para>Sets the VLAN ID for the specified interconnect or range of interconnects.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAVLANID</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAVLANID cmdlet sets the VLAN ID for the specified interconnect or range of interconnects. You must create a VLAN ID using the ADD-HPEOAVLAN command before using the Set-HPEOAVLANInterconnect command, or the command is rejected. All Virtual Connects that belong to the same domain must be on the same VLAN.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAVLANID</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>VLANID</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Target</maml:name> <maml:description> <maml:para>Target bay device for which the VLAN ID is to be set. Possible values are Interconnect and Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>VLANID</maml:name> <maml:description> <maml:para>VLAN ID to be set for the interconnect or range of interconnects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Value can be specified as ALL | <bay number>[{,|-} <bay number>])</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAVLANID requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANID –connection $connection –Target Server –VLANID 40 -Bay 2</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Target,VLANID and Name.</maml: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:para> </maml:introduction> <dev:code> PS C:\> PS C:> Set-HPEOAVLANID -Connection $connection Target not provided... Use same Target for all Connections? (y/n): y Please enter Target(Acceptable values are Server,Interconnect):Server VLANID not provided... Use same VLANID for all Connections? (y/n): y Please enter VLANID:50 Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 2 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Target,VLANID and Bay parameters are not provided for the OAs, you are asked to input the value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAVLANID –Target Server –VLANID 50 –Bay 2</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAVLANIPConfig</command:name> <maml:description> <maml:para>Temporarily sets the Onboard Administrator to DHCP or Static IP mode and the specified VLAN ID.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAVLANIPConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAVLANIPConfig cmdlet temporarily sets the Onboard Administrator to DHCP or Static IP mode and the specified VLAN ID.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access are required to execute this cmdlet.</maml:para> <maml:para>Warning: The connection is disconnected and you might not be able to access OA if this is improperly set (like setting a new VLAN ID).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAVLANIPConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Mode</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>VLANID</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>IP</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>NetMask</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>GateWay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Mode</maml:name> <maml:description> <maml:para>Specifies IP configuration mode for VLAN. Possible values are DHCP and Static.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the Onboard Administrator which is to be set to DHCP or Static IP mode. Valid values are Active or integer bay number of the Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>IP</maml:name> <maml:description> <maml:para>Static IP address assigned to the OA for Static IP config mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>NetMask</maml:name> <maml:description> <maml:para>Subnet mask for Static IP config mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>VLANID</maml:name> <maml:description> <maml:para>VLAN ID to be set to the Onboard Administrator. VLAN ID must be an integer between 0 and 4094. Setting the VLAN ID number to 0 disables enclosure VLAN. Any other setting enables enclosure VLAN. This option is for Static IP config mode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>GateWay</maml:name> <maml:description> <maml:para>Gateway for static IP config mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAVLANIPConfig requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANIPConfig –connection $connection -Mode Static -Bay 2 -VLANID 4 -IP 192.168.242.64 -NetMask 255.255.248.0 -GateWay 192.168.240.1</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Mode,Bay,VLANID,IP,NetMask and GateWay. After setting was applied for several seconds,it may have caused disconnect as the client machine and the Onboard Administrator must be on the same VLAN ID to access the Onboard Administrator.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANIPConfig –connection $connection -Mode DHCP –Bay 2</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Mode and Bay.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANIPConfig -Connection $connection –Bay 2 -IP 192.168.242.64 -NetMask 255.255.248.0 -GateWay 192.168.240.1 Mode not provided... Use same Mode for all Connections? (y/n): y Please enter Mode(Acceptable values are dhcp,static): static VLANID not provided... Use same VLANID for all Connections? (y/n): y Please enter VLANID:4 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Mode and VLANID parameters are not provided for the OAs, you are asked to input the value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAVLANIPConfig -Mode Static -Bay 2 -VLANID 4 -IP 192.168.242.64 -NetMask 255.255.248.0 -GateWay 192.168.240.1</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAVLANName</command:name> <maml:description> <maml:para>Edits the VLAN name for the specified VLAN ID.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAVLANName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAVLANName cmdlet edits the VLAN name for the specified VLAN ID.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAVLANName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <maml:description> <maml:para>VLAN id for which the name is to be changed. An integer from 1 to 4094.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Name to be assigned to the specified VLAN. Limited to 31 alphanumeric characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAVLANName requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANName –connection $connection –VLANID 50 –Name HPVLAN</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with VLANID and Name.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANName -Connection $connection –Name HPVLAN VLANID not provided... Use same VLANID for all Connections? (y/n): y Please enter VLANID: 50 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the VLANID parameter is not provided for the OAs, you are asked to input the value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAVLANName –VLANID 50 –Name HPVLAN</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAVLANOA</command:name> <maml:description> <maml:para>Sets or changes the VLAN ID of the Onboard Administrator. </maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P. </maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAVLANOA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAVLANOA cmdlet sets or changes the VLAN ID of the Onboard Administrator. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access are required to execute this cmdlet.</maml:para> <maml:para>Warning: The connection is disconnected and you might not be able to access OA if this is improperly set (like setting a new VLAN ID).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAVLANOA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>VLANID</maml:name> <maml:description> <maml:para>VLAN ID to be set to the Onboard Administrator. VLAN ID must be an integer between 0 and 4094. Setting the VLAN ID number to 0 disables enclosure VLAN. Any other setting enables enclosure VLAN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAVLANOA requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANOA –connection $connection –VLANID 2</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with VLANID.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANOA -Connection $connection VLANID not provided... Use same VLANID for all Connections? (y/n): y Please enter VLANID: 2 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the VLANID parameter is not provided for the OAs, you are asked to input the value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAVLANOA -VLANID 2</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAVLANRevert</command:name> <maml:description> <maml:para>Reverts VLAN settings back to saved FLASH configuration data in time indicated by the delay parameter.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAVLANRevert</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAVLANRevert cmdlet reverts VLAN settings back to saved FLASH configuration data in time indicated by the delay parameter. Any newly issued revert command takes precedence over an outstanding one.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAVLANRevert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Delay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Delay</maml:name> <maml:description> <maml:para>Time delay in seconds after which the VLAN settings are reverted to the settings saved in Flash.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAVLANRevert requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANRevert –connection $connection –Delay 60</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Delay.</maml: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:para> </maml:introduction> <dev:code> PS C:\> Set-HPEOAVLANRevert -Connection $connection Delay not provided... Use same Target for all Connections? (y/n): y Please enter Delay: 60 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the Delay parameter is not provided for the OAs, you are asked to input the value.</maml: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:para> </maml:introduction> <dev:code> PS C:\> $connection | Set-HPEOAVLANRevert –Delay 60</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HPEOAXMLReply</command:name> <maml:description> <maml:para>Enables or disables XML reply data over an HTTP connection.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAXMLReply</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAXMLReply cmdlet enables or disables XML reply data over an HTTP connection.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access are required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HPEOAXMLReply</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>Enable or Disable XML reply data over an HTTP connection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Set-HPEOAXMLReply requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAXMLReply -Connection $connection -State $state </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet along with State. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> Set-HPEOAXMLReply -Connection $connection State not provided... Use same State for all Connections? (y/n): n Please enter State for 192.168.242.62: enable Please enter State for 192.168.242.64: disable </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the parameter State is not input, you are prompted to input the values.</maml: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:\> $server | Set-HPEOAXMLReply</dev:code> <dev:remarks> <maml:para>In this example $server containing Connection and State information is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-HPEOACertificateDownload</command:name> <maml:description> <maml:para>Downloads a CA, HP SIM, LDAP, RemoteSupport, or User certificate.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEOACertificateDownload</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEOACertificateDownload cmdlet downloads the specified type of trust certificate (CA, HP SIM, LDAP, OA, RemoteSupport, or User certificate). </maml:para> <maml:para>When the Onboard Administrator is operating in FIPS mode, the minimum RSA key length is 2048 bits, and the signature hash algorithm must be SHA-224, SHA-256, SHA-384, or SHA-512.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access are required to execute this cmdlet.</maml:para> <maml:para>Warning: If a OA certificate is downloaded, OA will be rebooted and connection will be lost.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HPEOACertificateDownload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of certificate to be downloaded. Valid values are CA, OA, HPSIM, LDAP, RemoteSupport, and User. if the value is not set to User, then the value for Username parameter is not required. If the value is not set to OA, then the value for Bay parameter is not required. If the value is set to HPSIM,CA, LDAP, or RemoteSupport, then the values for Bay and Username parameters are not required. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>The URL from which the certificate is to be downloaded. It specifies the Host name in case of HP SIM certificate download.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Specifies the bay number for the Onboard Administrator if OA certificate is to be downloaded. Possible values can be Active, Standby, or the bay number of the Onboard Administrator. The default value Active is used if bay is not specified. This parameter is optional when Type is not set to OA.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the Username of the user for which the certificate is being downloaded for a user. This parameter is optional when Type is not set to User.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Start-HPEOACertificateDownload requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Start-HPEOACertificateDownload -Connection $connection -Type LDAP -URL ftp://192.168.243.56/cer_southking/ldap_southking.cer </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Type.</maml: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:\> Start-HPEOACertificateDownload -Connection $connection Type not provided... Use same Type for all Connections? (y/n): y Please enter Type (Acceptable values are LDAP, RemoteSupport, CA, HPSIM, User, OA): user URL not provided... Use same URL for all Connections? (y/n): n Please enter URL for 192.168.241.254: ftp://192.168.243.56/cer/user2.cer Please enter URL for 192.168.242.64: ftp://192.168.243.56/cer/user3.cer </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Type and URL are not provided, you are prompted to input the values.</maml: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:\> $connection | Start-HPEOACertificateDownload -Type HPSIM -URL 192.168.243.56</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-HPEOACertificateGeneration</command:name> <maml:description> <maml:para>Generates a pkcs#10 certificate request or a self-signed certificate.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEOACertificateGeneration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEOACertificateGeneration cmdlet generates a pkcs#10 certificate request or a self-signed certificate.</maml:para> <maml:para>When the Onboard Administrator is operating in FIPS mode, the minimum RSA key length is 2048 bits, and the signature hash algorithm must be SHA-224, SHA-256, SHA-384, or SHA-512.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access are required to execute this cmdlet. </maml:para> <maml:para>Warning: If a self-signed certificate is generated, OA will be rebooted and connection will be lost. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HPEOACertificateGeneration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Hostname</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Organization</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""> <maml:name>City</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases=""> <maml:name>State</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases=""> <maml:name>Country</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Unit</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ContactPerson</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Email</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Surname</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>GivenName</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>AlternativeName</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Initials</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DNQualifier</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ChallengePassword</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>UnstructuredName</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the certificate to be generated. Valid values are 'REQUEST' and 'SELFSIGNED'. If value is set to 'REQUEST', it generates a pkcs#10 certificate request; If the value is set to 'SELFSIGNED', a self-signed certificate will be generated. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The Onboard Administrator name that appears in the browser web address field. This certificate attribute is generally referred to as the common name. Must be 1 to 60 characters long. To prevent security alerts, the value of this field must match the host name exactly as it is known by the web browser. The browser compares the host name in the resolved web address to the name that appears in the certificate. For example, if the web address in the address field is https://oa-001635.xyz.com, then the value must be oa-001635.xyz.com.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""> <maml:name>Organization</maml:name> <maml:description> <maml:para>The company or organization that owns this Onboard Administrator. When this information is used to generate a certificate signing request, the issuing certificate authority can verify that the organization requesting the certificate is legally entitled to claim ownership of the given company name or organization name.Must be 1 to 60 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""> <maml:name>City</maml:name> <maml:description> <maml:para>The city or locality where the Onboard Administrator is located. Must be 1 to 50 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5" aliases=""> <maml:name>State</maml:name> <maml:description> <maml:para>The state or province where the Onboard Administrator is located.Must be 1 to 30 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6" aliases=""> <maml:name>Country</maml:name> <maml:description> <maml:para>The two-character country code that identifies the country where the Onboard Administrator is located. Must be a two-character country code. Acceptable characters are alphanumeric, space, and these punctuation marks: '()+,-./:=?.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Unit</maml:name> <maml:description> <maml:para>The unit within the company or organization that owns the Onboard Administrator. This is an optional parameter and must be 0 to 60 characters long.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ContactPerson</maml:name> <maml:description> <maml:para>The person responsible for the Onboard Administrator. This is an optional parameter and must be 0 to 60 characters long.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Email</maml:name> <maml:description> <maml:para>The email address of the contact person responsible for the Onboard Administrator. This is an optional parameter and must be 0 to 60 characters long.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Surname</maml:name> <maml:description> <maml:para>The surname of the person responsible for the Onboard Administrator. This is an optional parameter and must be 0 to 60 characters long.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>GivenName</maml:name> <maml:description> <maml:para>The given name of the person responsible for the Onboard Administrator. This is an optional parameter and must be 0 to 60 characters long.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>AlternativeName</maml:name> <maml:description> <maml:para>An alternative name of the person responsible for the Onboard Administrator. The name is used for creating the X509v3 Subject Alternative Name extension attribute. This is an optional parameter and must be 0 to 512 characters long. The field must either be empty or contain a list of keyword:value pairs separated by commas. The valid keyword:value entries include IP:<ipaddress> and DNS:<domain name>..</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Initials</maml:name> <maml:description> <maml:para>The initials of the person responsible for the Onboard Administrator. This is an optional parameter and must be 0 to 20 characters long.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>DNQualifier</maml:name> <maml:description> <maml:para>The distinguished name qualifier of the Onboard Administrator. This is an optional parameter and must be 0 to 60 characters long.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>ChallengePassword</maml:name> <maml:description> <maml:para>The password to the certificate-signing request. This is an optional parameter and must be 0 to 20 characters long. This parameter will be used only when Type is specified as REQUEST.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>UnstructuredName</maml:name> <maml:description> <maml:para>This is for additional information (for example, an unstructured name that is assigned to the Onboard Administrator). This is an optional parameter and must be 0 to 60 characters long.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Start-HPEOACertificateGeneration requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Start-HPEOACertificateDownload -Connection $connection -Type LDAP -URL ftp://192.168.243.56/cer_southking/ldap_southking.cer </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with Type.</maml: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:\> Start-HPEOACertificateDownload -Connection $connection Type not provided... Use same Type for all Connections? (y/n): y Please enter Type (Acceptable values are LDAP, RemoteSupport, CA, HPSIM, User, OA): user URL not provided... Use same URL for all Connections? (y/n): n Please enter URL for 192.168.241.254: ftp://192.168.243.56/cer/user2.cer Please enter URL for 192.168.242.64: ftp://192.168.243.56/cer/user3.cer </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters Type and URL are not provided, you are prompted to input the values.</maml: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:\> $connection | Start-HPEOACertificateDownload -Type HPSIM -URL 192.168.243.56</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-HPEOAConfigDownload</command:name> <maml:description> <maml:para>Downloads a previously saved configuration script file from a specific IP host, and then executes it.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEOAConfigDownload</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEOAConfigDownload cmdlet downloads a previously saved configuration script file from a specific IP host, and then executes it. Supported protocols are HTTP, FTP, TFTP, and USB. If your FTP server does not support anonymous connections, then specify a user name and password by replacing the host part in the above format with username:password@host.</maml:para> <maml:para>The file cannot change the Administrator account password. The user password is not saved or restored by the Start-HPEOAConfigDownload command.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HPEOAConfigDownload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>The URL where the configuration script file is located. Format the <URL> as protocol://host/path/file.</maml:para> <maml:para>The URL syntax for IPv6 addresses is protocol://[<ipv6_address>]/path/file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Start-HPEOAConfigDownload requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Start-HPEOAConfigDownload -Connection $connection -URL ftp://192.168.243.55/config_common.txt </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with URL.</maml: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:\> Start-HPEOAConfigDownload -Connection $connection URL not provided... Use same URL for all Connections? (y/n): n Please enter URL for 192.168.241.254: ftp://192.168.243.55/config_northbeggar.txt Please enter URL for 192.168.242.64: ftp://192.168.243.55/config_southking.txt </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the URL parameter is not provided, you are prompted to input the values.</maml: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:\> $connection | Start-HPEOAConfigDownload -URL ftp://192.168.243.55/config_common.txt</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-HPEOAConfigUpload</command:name> <maml:description> <maml:para>Uploads a script to the specified URL which duplicates the current runtime configuration.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEOAConfigUpload</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEOAConfigUpload cmdlet uploads a script to the specified URL which duplicates the current runtime configuration. Supported protocols are FTP, TFTP, and USB. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HPEOAConfigUpload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>USB</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>URL to which a script is to be uploaded. The URL should be formatted as: protocol://host/path/filename. The URL syntax for IPv6 addresses is protocol://[ipv6 address]/path/file. If your FTP server does not support anonymous logins, you can specify a user name and password within the URL formatted as: ftp://username:password@host/path/filename. To save a configuration file to a USB key, use the USB command and provide a filename. If USB key is used, The URL should have 'USB' followed by a space and then the filename. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">URL to which a script is to be uploaded. When USB parameter is provided, it's a USB path.</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>USB</maml:name> <maml:description> <maml:para>Swtich parameter. A script filename which is to be uploaded to USB. If input is USB, URL is used as a filename and the format is xxx.cfg.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Start-HPEOAConfigDownload requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Start-HPEOAConfigUpload -Connection $connection -URL ftp://192.168.243.56/userA/xxx.cfg </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with URL.</maml: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:\> PS C:\> Start-HPEOAConfigUpload -Connection $connection -USB URL not provided... Use same URL for all Connections? (y/n): n Please enter URL for 192.168.241.254: xxx.cfg Please enter URL for 192.168.242.64: xxx.cfg </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the URL parameter is not provided, you are prompted to input the values.</maml: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:\> $connection | Start-HPEOAConfigUpload -URL ftp://192.168.243.56/userA/xxx.cfg</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-HPEOAFirmwareServerDiscovery</command:name> <maml:description> <maml:para>Starts manual firmware discovery.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEOAFirmwareServerDiscovery</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEOAFirmwareServerDiscovery cmdlet starts manual firmware discovery. The blade is reset, which simulates a removal and insertion of the blade.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or server administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HPEOAFirmwareServerDiscovery</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number of the blade for which firmware discovery is to be performed. Value can be specified as ALL|<bay number>[{,|-} <bay number>].</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Start-HPEOAFirmwareServerDiscovery requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Start-HPEOAFirmwareServerDiscovery -Connection $connection -Bay 1</dev:code> <dev:remarks> <maml:para>This example uses the basic parameters to start firmware discovery. Parameters in this example must be provided. After successful execution, check the server firmware log to verify its status.</maml: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:\> Start-HPEOAFirmwareServerDiscovery -Connection $connection Bay not provided... Please enter Bay: 1 </dev:code> <dev:remarks> <maml:para>This example starts firmware discovery using interactive input.</maml: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:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "Bay"="1"} PS C:\> $p | Start-HPEOAFirmwareServerDiscovery</dev:code> <dev:remarks> <maml:para>This example starts firmware discovery in pipeline.</maml: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>PS C:\> $connection | Start-HPEOAFirmwareServerDiscovery –Bay “1”</dev:code> <dev:remarks> <maml:para>This example starts firmware discovery using pipeline and command-line parameters.</maml: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>PS C:\> $connection | Start-HPEOAFirmwareServerDiscovery Bay not provided... Please enter Bay: 1 </dev:code> <dev:remarks> <maml:para>This example starts firmware discovery using pipeline and interactive input.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-HPEOAKeyGeneration</command:name> <maml:description> <maml:para>Generates new private keys associated with the Onboard Administrator SecureSH service and/or SSL web services.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEOAKeyGeneration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEOAKeyGeneration cmdlet generates new private keys associated with the Onboard Administrator SecureSH service and/or SSL web services with optionally specified key size. Any self-signed or uploaded web service certificates generated using existing keys will be reset. Administrator account privileges are required. DSA hash is always SHA1 (160 bits). When running in FIPS mode, the SSH DSA default key size is 1024.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> <maml:para>Warning: Connection will be lost once the new private keys are generated successfully.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HPEOAKeyGeneration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>WebService</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Algorithm</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>KeySize</maml:name> <maml:description> <maml:para>Key size to be used in key generation algorithm. Accepted values are 384, 1024, 2048|, and 3072. Default value is 2048.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:defaultValue>2048</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>WebService</maml:name> <maml:description> <maml:para> Specifies the Onboard Administrator web service with which the generated key is to be associated. Value can be specified as All|SecureSH|SSL|SSL Alternate_Key. </maml:para> <maml:para> Note :- SSL Alternate_Key option is used to generate the new SSL key without removing the existing SSL key and certificates. Existing SSL key and certificates will continue to work until the new key is activated. The new key is activated either by generating self-signed certificate or by uploading the CA signed CSR which was generated using this new key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Algorithm</maml:name> <maml:description> <maml:para> Specifies the key generation algorithm. Value can be specified as SHA1|SHA-224|SHA-256|SHA-384|SHA-512. Default is SHA-256 for SSL keys.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SHA-256</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>KeySize</maml:name> <maml:description> <maml:para>Key size to be used in key generation algorithm. Accepted values are 384, 1024, 2048, and 3072. Default value is 2048.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2048</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Start-HPEOAKeyGeneration requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Start-HPEOAKeyGeneration -Connection $connection -WebService SSL -KeySize 1024 -Algorithm SHA1 IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.241.254 northwind.company.net Warning ... 192.168.242.64 southwind.company.net Error Invalid Arguments </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with WebService, KeySize, and Algorithm.</maml: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:\> Start-HPEOAKeyGeneration -Connection $connection WebService not provided... Use same WebService for all Connections? (y/n): n Please enter WebService for 192.168.241.254: SECURESH Please enter WebService for 192.168.242.64: SSL IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.241.254 northwind.company.net Warning ... 192.168.242.64 southwind.company.net Error Invalid Arguments </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the WebService parameter is not provided, you are prompted to input the values. If parameter KeySize is not specified, 2048 is used by default. If parameter Algorithm is not provided, SHA-256 is used by default for SSL keys.</maml: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:\> $Keys = $connection | Start-HPEOAKeyGeneration -WebService ALL -KeySize 2048 PS C:\> $Keys IP : 192.168.10.91 Hostname : abc.domain.com StatusType : Warning StatusMessage : It may take several minutes to create the new private keys. You will be logged out when the operation is complete. Generating 2048 Bit RSA SSH private key: sed: /etc/ssh/ssh_config: No such file or directory sed: /etc/ssh/ssh_config: No such file or directory sed: /etc/ssh/ssh_config: No such file or directory Generating 2048 Bit RSA HTTP private key: Done Generating new HTTP public certificate Operation was successful. IP : 192.168.10.51 Hostname : xyz.domain.com StatusType : Error StatusMessage : Invalid Arguments </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-HPEOASSHKeyDownload</command:name> <maml:description> <maml:para>Downloads an authorized key file to use for SSH logins.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEOASSHKeyDownload</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEOASSHKeyDownload cmdlet downloads an authorized key file to use for SSH logins. The file contains the public keys for users. Supported protocols are HTTP, FTP, and TFTP.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HPEOASSHKeyDownload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para> URL where the authorized key file is located. Format the URL as protocol://host/path/file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Start-HPEOASSHKeyDownload requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Start-HPEOASSHKeyDownload -Connection $connection -URL ftp://192.168.243.56/Bensshkey.ssh</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter along with URL.</maml: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:\> Start-HPEOASSHKeyDownload -Connection $connection URL not provided... Use same URL for all Connections? (y/n): y Please enter URL: ftp://192.168.243.56/Bensshkey.ssh </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because the URL is not provided, you are prompted to input the value.</maml: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:\> $connection | Start-HPEOASSHKeyDownload -URL ftp://192.168.243.56/Bensshkey.ssh</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-HPEOASupportDumpUpload</command:name> <maml:description> <maml:para>Uploads support dump data to the specified URL.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEOASupportDumpUpload</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEOASupportDumpUpload cmdlet uploads support dump data to the specified URL. Supported protocols are FTP, TFTP, and USB. You cannot use the cmdlet Start-HPEOASupportDumpUpload when FIPS Mode is set to 'On' or 'Debug'.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HPEOASupportDumpUpload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>Specifies the URL to which support dump data is to be uploaded. The URL must be formatted as: protocol://host/path/filename. This parameter is mandatory. The URL syntax for IPv6 addresses is protocol://[ipv6 address]/path/file. If your FTP server does not support anonymous logins, a username and password can be specified within the URL formatted as: ftp://username:password@host/path/filename. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Start-HPEOAASupportDumpUpload requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Start-HPEOASupportDumpUpload -Connection $connection -URL “ftp://192.168.243.56/userA/dump”</dev:code> <dev:remarks> <maml:para>This example uses the basic parameters to start dump upload. Parameters in this example must be provided. After successful execution, the file will be uploaded to the URL path.</maml: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:\> Start-HPEOASupportDumpUpload -Connection $connection URL not provided... Please enter URL: ftp://192.168.243.56/userA/dump </dev:code> <dev:remarks> <maml:para>This example starts dump upload using interactive input.</maml: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:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "URL"="ftp://192.168.243.56/userA/dump"} PS C:\> $p | Start-HPEOASupportDumpUpload </dev:code> <dev:remarks> <maml:para>This example starts dump upload in pipeline.</maml: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>PS C:\> $connection | Start-HPEOASupportDumpUpload -URL “ftp://192.168.243.56/userA/dump”</dev:code> <dev:remarks> <maml:para>This example starts dump upload using pipeline and command-line parameters.</maml: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>PS C:\> $connection | Start-HPEOASupportDumpUpload URL not provided... Please enter URL: ftp://192.168.243.56/userA/dump </dev:code> <dev:remarks> <maml:para>This example starts dump upload using pipeline and interactive input.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-HPEOASyslogUpload</command:name> <maml:description> <maml:para>Uploads the extended system log history for the current Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEOASyslogUpload</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEOASyslogUpload cmdlet uploads the extended system log history for the current Onboard Administrator. Supported protocols are FTP, TFTP, and USB.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator, OA operator, or OA user access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HPEOASyslogUpload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>The URL must be formatted as: protocol://host/path/filename. The URL syntax for IPv6 addresses is protocol://[<ipv6 address>]/path/file.</maml:para> <maml:para>If your FTP server does not support anonymous logins, a username and password can be specified within the URL formatted as: ftp://username:password@host/path/filename.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Start-HPEOASyslogUpload requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Start-HPEOASyslogUpload -Connection $connection -URL “ftp://192.168.243.56/userA/elog.txt”</dev:code> <dev:remarks> <maml:para>This example uses the basic parameters to start OA system log upload. Parameters in this example must be provided. After successful execution, the file will be uploaded to the URL path.</maml: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:\> Start-HPEOASyslogUpload -Connection $connection URL not provided... Please enter URL: ftp://192.168.243.56/userA/elog.txt </dev:code> <dev:remarks> <maml:para>This example starts OA system log upload using interactive input.</maml: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:\> $p = New-Object -TypeName PSObject -Property @{ "Connection"=$connection; "URL"="ftp://192.168.243.56/userA/elog.txt"} PS C:\> $p | Start-HPEOASyslogUpload </dev:code> <dev:remarks> <maml:para>This example starts OA system log upload in pipeline.</maml: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>PS C:\> $connection | Start-HPEOASyslogUpload -URL “ftp://192.168.243.56/userA/elog.txt”</dev:code> <dev:remarks> <maml:para>This example starts OA system log upload using pipeline and command-line parameters.</maml: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>PS C:\> $connection | Start-HPEOASyslogUpload URL not provided... Please enter URL: ftp://192.168.243.56/userA/elog.txt </dev:code> <dev:remarks> <maml:para>This example starts OA system log upload using pipeline and interactive input.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Switch-HPEOA</command:name> <maml:description> <maml:para>Forces the standby Onboard Administrator to become the active Onboard Administrator.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Switch</command:verb> <command:noun>HPEOA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Switch-HPEOA cmdlet forces the standby Onboard Administrator to become the active Onboard Administrator. The active becomes the standby and the standby becomes the active.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Switch-HPEOA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Switch-HPEOA requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Switch-HPEOA -Connection $connection</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed.</maml: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:\> $connection | Switch-HPEOA</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-HPEOAAlertMail</command:name> <maml:description> <maml:para>Sends a test AlertMail message to the configured email address.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEOAAlertMail</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEOAAlertMail cmdlet sends a test AlertMail message to the configured email address.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HPEOAAlertMail</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Test-HPEOAAlertMail requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with test result is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Test-HPEOAAlertMail -Connection $connection</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed.</maml: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:\> $connection | Test-HPEOAAlertMail</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-HPEOAConnection</command:name> <maml:description> <maml:para>Determines if the SSH connection to the Onboard Administrator is currently valid or expired.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEOAConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEOAConnection cmdlet determines if the SSH connection to the Onboard Administrator is currently valid or expired.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HPEOAConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with connection status is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Test-HPEOAConnection -Connection $connections | fl * IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : Connected IP : 192.168.241.254 Hostname : northwind.company.net StatusType : Error StatusMessage : Disconnected </dev:code> <dev:remarks> <maml:para>In this example a list of OA connections is passed to Connection parameter. The $connection can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> $connections | Test-HPEOAConnection | fl * IP : 192.168.242.64 Hostname : southwind.company.net StatusType : OK StatusMessage : Connected IP : 192.168.241.254 Hostname : northwind.company.net StatusType : Error StatusMessage : Disconnected </dev:code> <dev:remarks> <maml:para>In this example connection is passed through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-HPEOALDAP</command:name> <maml:description> <maml:para>Runs LDAP tests and optionally attempts to login to the LDAP server using the username and password.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEOALDAP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEOALDAP cmdlet runs LDAP tests and optionally attempts to log in to the LDAP server using the username and password.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HPEOALDAP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Password</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to optionally log in to the LDAP server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to optionally log in to the LDAP server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Test-HPEOALDAP requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with test result is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Test-HPEOALDAP -Connection $connection -Username userA -Password passwordA</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as parameters along with Username and Password.</maml: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:\> $connection | Test-HPEOALDAP -Username userA -Password passwordA</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-HPEOARemoteSupport</command:name> <maml:description> <maml:para>Sends a test service alert.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEOARemoteSupport</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEOARemoteSupport cmdlet sends a test service alert. Remote Support must be enabled before sending a test event. If the enclosure contains a large number of blades, the test might take several minutes. After the test has completed, the status is reflected in the Get-HPEOARemoteSupport command output.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HPEOARemoteSupport</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Test-HPEOARemoteSupport requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with test result is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Test-HPEOARemoteSupport -Connection $connection IP Hostname StatusType StatusMessage -- -------- ----------- ------------- 192.168.242.63 westwind.company.net Warning Sending service test event. Please run 'Get-HPEOAR... 192.168.242.64 southwind.company.net Warning Sending service test event. Please run 'Get-HPEOAR... </dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed as a parameter to the command line.</maml: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 | Test-HPEOARemoteSupport IP Hostname StatusType StatusMessage -- -------- ---------- ------------- 192.168.242.63 westwind.company.net Warning Sending service test event. Please run 'Get-HPEOAR... 192.168.242.64 southwind.company.net Warning Sending service test event. Please run 'Get-HPEOAR... </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-HPEOASNMP</command:name> <maml:description> <maml:para>Sends a test SNMP trap to all of the configured trap destinations.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEOASNMP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEOASNMP cmdlet sends a test SNMP trap to all of the configured trap destinations. You must enable SNMP to use this function.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HPEOASNMP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Test-HPEOASNMP requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with test result is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Test-HPEOASNMP -Connection $connection</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed.</maml: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:\> $connection | Test- HPEOASNMP</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-HPEOASyslog</command:name> <maml:description> <maml:para>Tests the remote system log settings by logging a test message to the syslog.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEOASyslog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEOASyslog cmdlet tests the remote system log settings by logging a test message to the syslog. The test message also appears in the local OA administrator system log.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HPEOASyslog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Test-HPEOASyslog requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with test result is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Test-HPEOASyslog -Connection $connection</dev:code> <dev:remarks> <maml:para>In this example the list of OA connection is passed.</maml: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:\> $connection | Test- HPEOASyslog</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-HPEOAURB</command:name> <maml:description> <maml:para>Manually sends the URB message to the endpoint.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEOAURB</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEOAURB cmdlet manually sends the URB message to the endpoint. This command can be useful for testing the configuration or resending a message after a failure. If the test fails, executing the Test-HPEOAURB command updates the last attempt status and logs a syslog message. This only works if URB reporting is enabled. </maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HPEOAURB</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Test-HPEOAURB requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with test result is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Test-HPEOAURB -Connection $connection IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : Warning StatusMessage : The OA is preparing to send a Utility Ready Blade (URB) notification. Once the message has been sent, the status will be reflected in the Get-HPEOAURB command. </dev:code> <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:\> $connection | Test- HPEOAURB IP : 192.168.242.62 Hostname : eastwind.company.net StatusType : Warning StatusMessage : The OA is preparing to send a Utility Ready Blade (URB) notification. Once the message has been sent, the status will be reflected in the Get-HPEOAURB command. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet through pipeline. It can be an Object or an Object array returned from Connect-HPEOA.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-HPEOAFirmware</command:name> <maml:description> <maml:para>Downloads a new flash image from the network and uses it to update the Onboard Administrator firmware.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>HPEOAFirmware</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-HPEOAFirmware cmdlet downloads a new flash image from the network and uses it to update the Onboard Administrator firmware. If a standby Onboard Administrator is present in the system, then this command flashes and validates its firmware before attempting to flash the active Onboard Administrator.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or OA operator access is required to execute this cmdlet.</maml:para> <maml:para>Warning. It takes several minutes to complete the operation. OA is restarted when the firmware update is complete, so the OA connection will be lost, It will be necessary to reconnect OA for the additional operations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-HPEOAFirmware</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Source</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>AllowDowngrade</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies the source of the file from which the firmware is to be installed. Valid values are FW_ISO, URL, or Sync. - If Source is set to SYNC, it initiates a firmware synchronization of the Active and Standby Onboard Administrators. If value is set to SYNC, then the value for URL parameter is not required. - If Source is set to FW_ISO, it updates the Onboard Administrator firmware using an image on a firmware CD. Enclosure Firmware Management must be configured with a valid ISO URL. See Set-HPEOAFWManagement for reference. If the value is set to FW_ISO, then the value for URL parameter is not required. - If Source is set to URL, the URL parameter is needed. The URL can be a network URL or a USB path to the ISO file with the firmware.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>The cmdlet downloads a new flash image from the network or USB device from the URL and uses it to update the Onboard Administrator firmware. This parameter is used when Source is set to URL.</maml:para> <maml:para>The URL of network must be formatted as: protocol://host/path/filename. The URL syntax for IPv6 addresses is protocol://[<ipv6 address>]/path/file. Supported protocols are HTTP, FTP, and TFTP.</maml:para> <maml:para>If your FTP server does not support anonymous logins, a username and password can be specified within the URL formatted as ftp://username:password@host/path/filename.</maml:para> <maml:para>The URL of a USB device must be formatted as usb://<directory name>/<script file name>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>AllowDowngrade</maml:name> <maml:description> <maml:para>Enables downgrading firmware even if settings and passwords might be lost.It is supported when URL or FW_ISO is specified with the Source parameter.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Update-HPEOAFirmware requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Update-HPEOAFirmware -Connection $connection -Source URL -URL ftp://192.168.243.56/HPEOA420.bin IP : 192.168.241.254 Hostname : northwind.company.net StatusType : Warning StatusMessage : Detected 2 Onboard Administrators, performing redundant flash upgrade Downloading image from ftp://192.168.243.56/HPEOA420.bin... Preparing to flash redundant Onboard Administrator... Flashing Standby Onboard Administrator Standby flash: ____ 0% ____ 2% ____ 4% ____ 6% . . . ____ 86% ____ 88% ____Done Waiting for standby to reboot... Done Flashing Active Onboard Administrator Active flash: ____ 0%____ 0% ____ 2% ____ 4%____ 4% . . . ____ 86%____ 86% ____ 88% ____ 88% *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. This example updates OA firmware with a new flash image from the network.</maml: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:\> $url = $(Get-HPEOAUSBKey -Connection $connection).FirmwareImageFiles.FileName PS C:\> $url usb://d1/HPEOA421.bin PS C:\> Update-HPEOAFirmware -Connection $connection -Source URL -URL $url IP : 192.168.242.64 Hostname : southwind.company.net StatusType : Warning StatusMessage : Downloading image from ftp://192.168.243.56/HPEOA420.bin... Verifying signature... successful! Key1 The flash process begins in 10 seconds. Flashing... ____ 0%____ 0% ____ 2%____ 2% ____ 4%____ 4% ____ 6%____ 6% ____ 8%____ 8% . . . ____ 92%____ 94%____ 94% ____ 96%____ 96% ____ 98%____ 98%____100% ____100% Firmware image flashed from 4.20 to 4.20 *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... To check the result, please refer to OA guide. IP : 192.168.242.63 Hostname : southwind.company.net StatusType : Warning StatusMessage : Downloading image from ftp://192.168.243.56/HPEOA420.bin... Verifying signature... successful! Key1 The flash process begins in 10 seconds. Flashing... ____ 0%____ 0% ____ 2%____ 2% ____ 4%____ 4% ____ 6%____ 6% . . . ____ 92%____ 94%____ 94% ____ 96%____ 96% ____ 98%____ 98%____100% ____100% Firmware image flashed from 4.11 to 4.20 *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... To check the result, please refer to OA guide. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. This example updates OA firmware with a new flash image from a USB key. Get-HPEOAUSBKey gets the URL of the file in USB device.</maml: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:\> Set-HPEOAFWManagement -Connection $connection -State Enable -URL http://192.168.243.31/FW930.iso PS C:\> Update-HPEOAFirmware -Connection $connection -Source FW_ISO </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. This example updates OA firmware using an image on a firmware CD. The firmware CD must first be mounted using Set-HPEOAFWManagement.</maml: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>PS C:\> Update-HPEOAFirmware -Connection $connection -Source Sync IP : 192.168.241.254 Hostname : northwind.company.net StatusType : Warning StatusMessage : Detecting OA firmware version and settings... This OA (ACTIVE) : 4.11 Redundant OA (STANDBY): 4.20 This (ACTIVE) OA will be upgraded to firmware v4.20 Building firmware image from other (STANDBY) OA.... Starting flash... Flashing Active Onboard Administrator Active flash: 0% 0% 2% 2% 6% 6% 8% 8% . . . 94% 94% 96% 96% 98% 98% 100% *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. This example shows a Firmware Sync of the Active and Standby OA.</maml: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>PS C:\> Update-HPEOAFirmware -Connection $connection Source not provided... Use same Source for all Connections? (y/n): y Please enter Source: Sync IP : 192.168.241.254 Hostname : northwind.company.net StatusType : Warning StatusMessage : Detecting OA firmware version and settings... This OA (ACTIVE) : 4.21 Redundant OA (STANDBY): 4.21 The Active and Standby Onboard Administrator already have the same firmware version installed. IP : 192.168.241.253 Hostname : northwind.company.net StatusType : Warning StatusMessage : Detecting OA firmware version and settings... This OA (ACTIVE) : 4.21 Redundant OA (STANDBY): 4.21 The Active and Standby Onboard Administrator already have the same firmware version installed. </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameter Source is not provided, you are prompted to input the value.</maml: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>PS C:\> $server | Update-HPEOAFirmware -URL $url -AllowDowngrade IP : 192.168.242.64 Hostname : southwind.company.net StatusType : Warning StatusMessage : Downloading image from ftp://192.168.243.56/HPEOA420.bin... Verifying signature... successful! Key1 The flash process begins in 10 seconds. Flashing... ____ 0%____ 0% ____ 2%____ 2% ____ 4%____ 4% ____ 6%____ 6% . . . ____ 92%____ 94%____ 94% ____ 96%____ 96% ____ 98%____ 98%____100% ____100% Firmware image flashed from 4.20 to 4.20 *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... *** Broadcast message *** Restarting Onboard Administrator in 5 seconds... </dev:code> <dev:remarks> <maml:para>In this example $server including Connection and Source information is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-HPEOAFWServer</command:name> <maml:description> <maml:para>Initiates manual update of the selected servers using the configured HP firmware ISO image URL.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>HPEOAFWServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-HPEOAFWServer cmdlet initiates manual update of the selected servers using the configured HP firmware ISO image URL.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or server administrator with bay specific access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-HPEOAFWServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) of the server(s) for which the firmware is to be updated. Values can be specified as All | <bay number> [,|- <bay number>]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Update-HPEOAFWServer requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Update-HPEOAFWServer -Connection $connection -Bay $bay</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> Update-HPEOAFWServer -Connection $connection Bay not provided... Use same Bay for all Connections? (y/n): y Please enter Bay: 1 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameter Bay is not provided, you are prompted to input the value.</maml: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:\> $server | Update-HPEOAFWServer </dev:code> <dev:remarks> <maml:para>In this example $server including Connection and Bay information is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-HPEOAiLO</command:name> <maml:description> <maml:para>Downloads a new flash image from the network and uses it to update the firmware for iLO.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>HPEOAiLO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-HPEOAiLO cmdlet downloads a new flash image from the network and uses it to update the firmware for iLO. Supported protocols are HTTP, HTTPS, TFTP, and FTP. If maximum users exist in iLO (12), then this command fails. A user account must be available to execute this command. This command is not applicable to HP Integrity server blades.</maml:para> <maml:para>A list of connection objects must be provided as a parameter. OA administrator or operator with blade bay specific access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-HPEOAiLO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>URL</maml:name> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>TPMForce</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="BayNumber"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Bay number(s) for the server(s) where the iLO firmware is to be updated. Values can be specified as All | <bay number> [,|- <bay number>]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>URL</maml:name> <maml:description> <maml:para>URL of the ISO image of the firmware to be used to update the iLO. The URL must be formatted as protocol://host/path/filename. If your FTP server does not support anonymous logins, then a username and password can be specified within the URL that is formatted as: ftp://username/password@host/path/filename.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for a required parameter. Without this parameter, Update-HPEOAiLO requires you to provide the values of all required parameters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases=""> <maml:name>TPMForce</maml:name> <maml:description> <maml:para>Specifies a switch parameter to indicate TPM setting. If a Trusted Platform Module (TPM) is installed and enabled on the server blade, the cmdlet must include the TPMForce parameter. NOTICE:Upgrading an iLO without performing the proper OS encryption procedure will result in loss of access to your server data if a server TPM is enabled. If you do not have your recovery key or have not suspended encryption, do not flash iLO. The parameter is only supported on OA FW 4.11 or later.</maml:para> </maml:description> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Update-HPEOAiLO -Connection $connection -Bay $bay -URL $url</dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA.</maml: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:\> Update-HPEOAiLO -Connection $connection URL not provided... Use same URL for all Connections? (y/n): y Please enter URL: ftp://192.168.243.56/ilo3_170_p12.bin Bay not provided... Use same Bay for all Connections? (y/n): n Please enter Bay for 192.168.242.62: 1 Please enter Bay for 192.168.242.64: 2 </dev:code> <dev:remarks> <maml:para>In this example $connection is passed as parameter to the cmdlet. It can be an Object or an Object array returned from Connect-HPEOA. Because parameters URL and Bay are not provided, you are prompted to input the values.</maml: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:\> $server | Update-HPEOAiLO</dev:code> <dev:remarks> <maml:para>In this example $server including Connection, Bay, URL information is passed as parameter to the cmdlet through pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-HPEOAModuleVersion</command:name> <maml:description> <maml:para>Determines if an updated version of the Onboard Administrator cmdlets is available on Hewlett-Packard website and returns the link to download this new version.</maml:para> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2018 Hewlett Packard Enterprise Development Company, L.P.</maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>HPEOAModuleVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-HPEOAModuleVersion cmdlet determines if an updated version of the Onboard Administrator cmdlets is available on Hewlett-Packard website and returns the link to download this new version.</maml:para> <maml:para>All users can execute this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-HPEOAModuleVersion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para>When the cmdlet executes successfully, correct output with HPE OA Cmdlets and update information is generated. Otherwise, error message is produced.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Use Get-Member to get details of fields in returned objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>None</maml:para> </maml:alert> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Update-HPEOAModuleVersion There is a newer version of HPEOACmdlets available at http://www.hp.com/go/powershell. Do you want to go there to download the new version?(Y/N): Y </dev:code> <dev:remarks> <maml:para>In this example a newer version of cmdlets is available on HP website for download. Input Y to open the website with default browser.</maml: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:\> Update-HPiLOModuleVersion The currently installed version 1.0.0.1 is the most current. </dev:code> <dev:remarks> <maml:para>In this example the currently installed version is the most current.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Add-HPEOARouteIPv6</command:name> <maml:description> <maml:para>Adds an IPv6 static route to the Onboard Administrator routing table.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEOARouteIPv6</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEOARouteIPv6 cmdlet adds an IPv6 static route to the Onboard Administrator routing table. The static route defines an explicit path that the Onboard Administrator uses to reach an external network through a gateway. In a static network configuration, the static route removes the need to configure the router to send route information via router advertisements. A list of connection objects must be provided as parameter. OA administrator/operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEOARouteIPv6</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TargetOA</maml:name> <maml:description> <maml:para>Specifies the traget Onboard Administrator. The accepted values are "Active" and "Standby".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RouteDestination</maml:name> <maml:description> <maml:para>Specifies the IPv6 route destination. The IPv6 address must be in the form ####:####:####:####:####:####:####:####/### (with a prefix), where each #### ranges from 0 to FFFF. The prefix /### ranges from 1 to 128. A compressed version of the same IPv6 address is also supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RouteGateway</maml:name> <maml:description> <maml:para>Specifies the IPv6 route gateway. The IPv6 route gateway must be in the form ####:####:####:####:####:####:####:#### where #### ranges from 0 to FFFF. Do not specify a prefix. A compressed version of the same IPv6 address is also supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TargetOA</maml:name> <maml:description> <maml:para>Specifies the traget Onboard Administrator. The accepted values are "Active" and "Standby".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RouteDestination</maml:name> <maml:description> <maml:para>Specifies the IPv6 route destination. The IPv6 address must be in the form ####:####:####:####:####:####:####:####/### (with a prefix), where each #### ranges from 0 to FFFF. The prefix /### ranges from 1 to 128. A compressed version of the same IPv6 address is also supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RouteGateway</maml:name> <maml:description> <maml:para>Specifies the IPv6 route gateway. The IPv6 route gateway must be in the form ####:####:####:####:####:####:####:#### where #### ranges from 0 to FFFF. Do not specify a prefix. A compressed version of the same IPv6 address is also supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Add-HPEOARouteIPv6 -Connection $connection -TargetOA Active -RouteDestination 2001:0db8:85a3:0000:0000:8a2e:0370:7334/64 -RouteGateway 2001:0db8:85a3:0000:0000:8a2e:0370:ffff</dev:code> <dev:remarks> <maml:para>This example adds the Route IPv6 using the connection object as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Add-HPEOARouteIPv6 -TargetOA Active -RouteDestination 2001:0db8:85a3:0000:0000:8a2e:0ab0:7334/64 -RouteGateway 2001:0db8:85a3:0000:0000:8a2e:0370:ffff</dev:code> <dev:remarks> <maml:para>This example adds the IPv6 route using the connection object as pipline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEOARouteIPv6</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOANetworkSetting</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-HPEOARouteIPv6</command:name> <maml:description> <maml:para>Removes an IPv6 static route from the Onboard Administrator IPv6 routing table.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEOARouteIPv6</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEOARouteIPv6 Cmdlet removes an IPv6 static route from the Onboard Administrator IPv6 routing table. OA administrator/operator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="RouteDestination" default="true"> <!--NAME: RouteDestination--> <!--TAG: DEFAULT--> <maml:name>Remove-HPEOARouteIPv6</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TargetOA</maml:name> <maml:description> <maml:para>Specifies the target Onboard Administrator. The accepted values are "Active" and "Standby"</maml:para> <maml:para>ParameterSetName: All</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RouteDestination</maml:name> <maml:description> <maml:para>Specifies the IPv6 route destination. The IPv6 address must be in the form ####:####:####:####:####:####:####:####/### (with a prefix), where each #### ranges from 0 to FFFF. The prefix /### ranges from 1 to 128. A compressed version of the same IPv6 address is also supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RouteGateway</maml:name> <maml:description> <maml:para>Specifies the IPv6 route gateway. The IPv6 route gateway must be in the form ####:####:####:####:####:####:####:#### where #### ranges from 0 to FFFF. Do not specify a prefix. A compressed version of the same IPv6 address is also supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RemoveAll"> <!--NAME: RemoveAll--> <maml:name>Remove-HPEOARouteIPv6</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TargetOA</maml:name> <maml:description> <maml:para>Specifies the target Onboard Administrator. The accepted values are "Active" and "Standby"</maml:para> <maml:para>ParameterSetName: All</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveAll</maml:name> <maml:description> <maml:para>Removes all the IPv6 routes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> <maml:para>ParameterSetName: All</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TargetOA</maml:name> <maml:description> <maml:para>Specifies the target Onboard Administrator. The accepted values are "Active" and "Standby"</maml:para> <maml:para>ParameterSetName: All</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RouteDestination</maml:name> <maml:description> <maml:para>Specifies the IPv6 route destination. The IPv6 address must be in the form ####:####:####:####:####:####:####:####/### (with a prefix), where each #### ranges from 0 to FFFF. The prefix /### ranges from 1 to 128. A compressed version of the same IPv6 address is also supported.</maml:para> <maml:para>ParameterSetName: RouteDestination</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RouteGateway</maml:name> <maml:description> <maml:para>Specifies the IPv6 route gateway. The IPv6 route gateway must be in the form ####:####:####:####:####:####:####:#### where #### ranges from 0 to FFFF. Do not specify a prefix. A compressed version of the same IPv6 address is also supported.</maml:para> <maml:para>ParameterSetName: RouteDestination</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveAll</maml:name> <maml:description> <maml:para>Removes all the IPv6 routes.</maml:para> <maml:para>ParameterSetName: RemoveAll</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> <maml:para>ParameterSetName: All</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> <maml:para>ParameterSetName: All</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-HPEOARouteIPv6 -Connection $connection -TrgetOA Active -RouteDestination 2001:0db8:85a3:0000:0000:8a2e:0370:7334/64 -RouteGateway 2001:0db8:85a3:0000:0000:8a2e:0370:ffff</dev:code> <dev:remarks> <maml:para>This example removes the IPv6 route using connection as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Remove-HPEOARouteIPv6 -TrgetOA Active -RemoveAll</dev:code> <dev:remarks> <maml:para>This example removes all the IPv6 routes where the connection object is passed as pipline input</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEOARouteIPv6</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOANetworkSetting</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPEOAFQDNLinkSuppot</command:name> <maml:description> <maml:para>Sets the FQDNLinkSupport to enable or disable.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOAFQDNLinkSuppot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOAFQDNLinkSuppot cmdlet enables/disables the FQDNLinkSupport. When FQDNLinkSUpport is enabled, the Onboard Administrator displays an FQDN-based web address link in addition to the usual IP-based web address links used for accessing an iLO or interconnect from the Onboard Administrator GUI.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEOAFQDNLinkSuppot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FQDNLinkSupport</maml:name> <maml:description> <maml:para>Specifies the FQDNLinkSupport state. Accpeted values are "Enbale" and "Disable"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FQDNLinkSupport</maml:name> <maml:description> <maml:para>Specifies the FQDNLinkSupport state. Accpeted values are "Enbale" and "Disable"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOAFQDNLinkSuppot -Connection $connection -FQDNLinkSupport Enable</dev:code> <dev:remarks> <maml:para>This example enables the FQDN links where the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Set-HPEOAFQDNLinkSuppot -FQDNLinkSupport Disable</dev:code> <dev:remarks> <maml:para>This example disables the FQDN links where the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOANetworkSetting</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPEOASSLProtocol</command:name> <maml:description> <maml:para>Gets the status of the SSL security protocol.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASSLProtocol</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASSLProtocol gets the status of the SSL security protocol.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEOASSLProtocol</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para /> </maml: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:\> $sslProtocol = Get-HPEOASSLProtocol -Connection $connetion PS C:\> $sslProtocol IP : 10.20.30.1 Hostname : abc.domain.com StatusType : OK StatusMessage : OK EnabledSecurityProtocol : {TLSv1, TLSv1.1, TLSv1.2} DisabledSecurityProtocol : {None}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPEOASSLProtocol where the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $sslProtocol = $connetion | Get-HPEOASSLProtocol PS C:\> $sslProtocol IP : 10.20.40.1 Hostname : xyz.domain.com StatusType : OK StatusMessage : OK EnabledSecurityProtocol : TLSv1 DisabledSecurityProtocol : {TLSv1.1, TLSv1.2}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPEOASSLProtocol where the connection object is passed as pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEOASSLProtocol</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPEOASSLProtocol</command:name> <maml:description> <maml:para>Sets the SSL security protocol.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOASSLProtocol</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOASSLProtocol cmdlet enbales/disables the SSL security protocol. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEOASSLProtocol</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the SSL security protocol. Accpeted values are "Enable" and "Disable".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSLProtocol</maml:name> <maml:description> <maml:para>Specifies the SSL security protocol. Accepted value are "TLSv1", "TLSv1.1", and "TLSv1.2".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the SSL security protocol. Accpeted values are "Enable" and "Disable".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSLProtocol</maml:name> <maml:description> <maml:para>Specifies the SSL security protocol. Accepted value are "TLSv1", "TLSv1.1", and "TLSv1.2".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOASSLProtocol -Connection $connection -State Enbale -SSLProtocol TLSv1</dev:code> <dev:remarks> <maml:para>This example enables the TLSv1 SSL security protocol where the connection object is passed through named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Set-HPEOASSLProtocol -State Disable -SSLProtocol TLSv1.2</dev:code> <dev:remarks> <maml:para>This example disables the TLSv1.2 SSL security protocol where the connection object is passed through pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOASSLProtocol</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPEOASSLCipher</command:name> <maml:description> <maml:para>Gets the status of security ciphers.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOASSLCipher</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOASSLCipher cmdlet gets the status of security ciphers used by the Onboard Administrator for negotiating TLS connections.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEOASSLCipher</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $sslCipher = Get-HPEOASSLCipher -Connection $connection PS C:\> $sslCipher IP : 10.20.30.40 Hostname : abc.domain.com StatusType : OK StatusMessage : OK EnabledCipher : {TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_CBC_SHA...} DisabledCipher : {None} C:\PS> $sslCipher.EnabledCipher TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_256_CBC_SHA TLS_DHE_RSA_WITH_AES_128_CBC_SHA TLS_DHE_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_RSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384</dev:code> <dev:remarks> <maml:para>This example gets the SSL cipher using the connection object as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $sslCipher = $connection | Get-HPEOASSLCipher PS C:\> $sslCipher IP : 10.20.30.50 Hostname : xyz.domain.com StatusType : OK StatusMessage : OK EnabledCipher : {TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384...} DisabledCipher : {TLS_DHE_RSA_WITH_AES_128_CBC_SHA} </dev:code> <dev:remarks> <maml:para>This example gets the SSL cipher using the connection object as pipline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEOASSLCipher</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPEOASSLCipher</command:name> <maml:description> <maml:para>Sets the SSL cipher to enable/disable for TLS connection</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOASSLCipher</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOASSLCipher cmdlet sets the specified security ciphers used by the Onboard Administrator for negotiating TLS connections. OA administrator access is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets" default="true"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEOASSLCipher</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the SSL cipher. The accepted values are "Enable" and "Disable."</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSLCipher</maml:name> <maml:description> <maml:para>Specifies the SSL cipher to be enabled or disabled. Use the Get-HPEOASSLCipher cmdlet to get the enbaled/disabled SSL cipher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of the SSL cipher. The accepted values are "Enable" and "Disable."</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSLCipher</maml:name> <maml:description> <maml:para>Specifies the SSL cipher to be enabled or disabled. Use the Get-HPEOASSLCipher cmdlet to get the enbaled/disabled SSL cipher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOASSLCipher -Connection $connection -State Enable -SSLCipher TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA </dev:code> <dev:remarks> <maml:para>This example enables the specified SSL cipher using connection as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Set-HPEOASSLCipher -State Disable -SSLCipher TLS_RSA_WITH_AES_256_CBC_SHA </dev:code> <dev:remarks> <maml:para>This example disables the specified SSL cipher where the connection object is passed as pipline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOASSLCipher</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Reset-HPEOAiLO</command:name> <maml:description> <maml:para>Resets the iLO in a bay.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPEOAiLO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPEOAiLO cmdlet resets the iLO in a bay. This requires administrator access level.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Reset-HPEOAiLO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Specifies the bay number where iLO needs to be reset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Bay</maml:name> <maml:description> <maml:para>Specifies the bay number where iLO needs to be reset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Reset-HPEOAiLO -Connection $connection -Bay 2</dev:code> <dev:remarks> <maml:para>This example resets the iLO in a specified bay where the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Reset-HPEOAiLO -Bay 2</dev:code> <dev:remarks> <maml:para>This example resets the iLO in a specified bay where the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Clear-HPEOAFirmwareLog</command:name> <maml:description> <maml:para>Clears all data from the Enclosure Firmware Management logs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEOAFirmwareLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEOAFirmwareLog clears all data from the Enclosure Firmware Management logs, including the Onboard Administrator's Enclosure Firmware Management log, and the server-specific Firmware log and Session log.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEOAFirmwareLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>ClearFirmwareLog</maml:name> <maml:description> <maml:para>Specify this parameter to clear firmware logs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>ClearFirmwareLog</maml:name> <maml:description> <maml:para>Specify this parameter to clear firmware logs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para /> </maml: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:\> Clear-HPEOAFirmwareLog -Connection $connetion -ClearFirmwareLog</dev:code> <dev:remarks> <maml:para>This example clears the firmware logs where the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connetion | Clear-HPEOAFirmwareLog -ClearFirmwareLog </dev:code> <dev:remarks> <maml:para>This example clears the firmware logs where the connection object is passed as pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPEOABladeBootFWDiscovery</command:name> <maml:description> <maml:para>Sets the offline firmware discovery policy for the enclosure.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOABladeBootFWDiscovery</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOABladeBootFWDiscovery cmdlet sets the offline firmware discovery policy for the enclosure. On enabling offline firmware discovery, a firmware discovery is performed to collect the extended firmware information for that server whenever the server completes the boot cycle which is caused due to server Power ON, Reset, or Cold Boot. Offline firmware discovery will discover only the current firmware version of blade components.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEOABladeBootFWDiscovery</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BladeBootFWDiscovery</maml:name> <maml:description> <maml:para>Specifies the state of BladeBootFWDiscovery. Accpeted values are "Enable" and "Disable".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BladeBootFWDiscovery</maml:name> <maml:description> <maml:para>Specifies the state of BladeBootFWDiscovery. Accpeted values are "Enable" and "Disable".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOABladeBootFWDiscovery -Connection $connection -BladeBootFWDiscovery Enable</dev:code> <dev:remarks> <maml:para>This example enables the BladeBootFWDiscovery where the connection object is passed through named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Set-HPEOABladeBootFWDiscovery -BladeBootFWDiscovery Disable</dev:code> <dev:remarks> <maml:para>This example disables the BladeBootFWDiscovery where the connection object is passed through pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPEOACACInfo</command:name> <maml:description> <maml:para>Gets the CAC authentication status.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOACACInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOACACInfo cmdlet gets the configuration details for CAC authentication.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEOACACInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $cacInfo = Get-HPEOACACInfo -Connection $connection PS C:\> $cacInfo IP : 192.168.10.91 Hostname : abc.domain.com StatusType : OK StatusMessage : OK CACAuthentication : Disabled CertificateRevocation : Enabled OnlineCertificateRevocation : Enabled CertificateOwnerField : Subject </dev:code> <dev:remarks> <maml:para>This example shows the CAC authentication details where the connection object is passed through named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $cacInfo = $connection | Get-HPEOACACInfo PS C:\> $cacInfo IP : 192.168.10.51 Hostname : xyz.domain.com StatusType : OK StatusMessage : OK CACAuthentication : Disabled CertificateRevocation : Enabled OnlineCertificateRevocation : Enabled CertificateOwnerField : Subject </dev:code> <dev:remarks> <maml:para>This example shows the CAC authentication where the connection object is passed through pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Disable-HPEOAOCSP</command:name> <maml:description> <maml:para>Disables the certification revocation check.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEOAOCSP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPEOAOCSP cmdlet disables certificate revocation check using Online Certificate Status Protocol (OCSP). This requires administrator access level.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEOAOCSP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DisableOCSP</maml:name> <maml:description> <maml:para>Specifies the SwitchParameter to disable OCSP (Online Certificate Status Protocol).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DisableOCSP</maml:name> <maml:description> <maml:para>Specifies the SwitchParameter to disable OCSP (Online Certificate Status Protocol).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Disable-HPEOAOCSP -Connection $connection -DisableOCSP</dev:code> <dev:remarks> <maml:para>This example disables the OCSP(Online Certificate Status Protocol) where the connection object is passed through named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Disable-HPEOAOCSP -DisableOCSP</dev:code> <dev:remarks> <maml:para>This example disables the OCSP(Online Certificate Status Protocol) where the connection object is passed through pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEOACACInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPEOALDAPServiceAccount</command:name> <maml:description> <maml:para>Sets the service account username and password of the LDAP server for CAC authentication.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEOALDAPServiceAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEOALDAPServiceAccount cmdlet does the following:</maml:para> <maml:para>1) Enables/Disables the LDAP service account.</maml:para> <maml:para>2) Sets the service account username and password of the LDAP server used for CAC authentication.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePassword" default="true"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEOALDAPServiceAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the LDAP service account username. Do not use double quotes (") and single quotes (') in username.</maml:para> <maml:para>ParameterSetName = UsernamePassword</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the LDAP service account password. Do not use double quotes (") and single quotes (') in password.</maml:para> <maml:para>ParameterSetName = UsernamePassword</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> <maml:para>ParameterSetName = All</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="EnableDisable"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEOALDAPServiceAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of LDAP service account. Accpeted values are "Enable" and "Disable".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> <maml:para>ParameterSetName = All</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> <maml:para>ParameterSetName = ALL</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state of BladeBootFWDiscovery. Accpeted values are "Enable" and "Disable".</maml:para> <maml:para>ParameterSetName = EnableDisable</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the LDAP service account username. Do not use double quotes (") and single quotes (') in username.</maml:para> <maml:para>ParameterSetName = UsernamePassword</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the LDAP service account password. Do not use double quotes (") and single quotes (') in password.</maml:para> <maml:para>ParameterSetName = UsernamePassword</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> <maml:para>ParameterSetName = All</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> <maml:para>ParameterSetName = All</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>Do not use double quotes (") and single quotes (') in the username and password parameters.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Set-HPEOALDAPServiceAccount -Connection $connection -State Enable </dev:code> <dev:remarks> <maml:para>This example enables the LDAP service account, where the connection object is passed through named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Set-HPEOALDAPServiceAccount -Username testUser -Password testUser123 </dev:code> <dev:remarks> <maml:para>This example sets the LDAP service account username and password, where the connection object is passed through pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection | Set-HPEOALDAPServiceAccount</dev:code> <dev:remarks> <maml:para>This example sets the LDAP service account to none, where the connection object is passed through pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPEOALDAPServiceAccount</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Test-HPEOALDAPServiceAccount</command:name> <maml:description> <maml:para>Tests the LDAP service account.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEOALDAPServiceAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEOALDAPServiceAccount cmdlet runs LDAP tests and optionally attempts to login to the LDAP server using the service account username and password.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Test-HPEOALDAPServiceAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the LDAP service account username. Do not use double quotes (") and single quotes (') in username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the LDAP service account password. Do not use double quotes (") and single quotes (') in password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the LDAP service account username. Do not use double quotes (") and single quotes (') in username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the LDAP service account password. Do not use double quotes (") and single quotes (') in password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String, PSObject, list of String and/or PSObject</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>Do not use double quotes (") and single quotes (') in the username and password parameters.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $result = Test-HPEOALDAPServiceAccount -Connection $connection -Username testUser -Password testUser123 PS C:\> $result IP : 192.168.10.21 Hostname : abc.domain.com StatusType : OK StatusMessage : OK </dev:code> <dev:remarks> <maml:para>This example tests LDAP service account using username and password, where the connection object is passed through named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $result = $connection | Test-HPEOALDAPServiceAccount PS C:\> $result IP : 192.168.10.51 Hostname : xyz.domain.com StatusType : OK StatusMessage : OK </dev:code> <dev:remarks> <maml:para>This example tests the LDAP service account without logging in to the LDAP server where the connection object is passed through pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEOALDAPServiceAccount</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPEOAAlertmail</command:name> <maml:description> <maml:para>Gets the alert mail configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEOAAlertmail</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEOAAlertmail cmdlet gets the alert mail configuration.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEOAAlertmail</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="conn"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to an OA. This is a session object which identifies the Host to which the connection is established. The Connection object is created by the Connect-HPEOA command using the IP/Hostname and accompanying Username and Password to log into the OA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Renci.SshNet.SshClient object or list of Renci.SshNet.SshClient objects</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible value can be RawText or PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt for the required parameter(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>PSObject OR array of PSObject OR String OR array of String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe one connection object or a list of connection objects, or one PSObject or list of PSObjects having the Connection object and other parameter values to be modified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $mailSetting = Get-HPEOAAlertmail -Connection $connection PS C:\> $mailSetting IP : 192.168.10.91 Hostname : abc.domian.com StatusType : OK StatusMessage : OK Status : Enabled Email : testmail.abc@xyz.com SMTPServer : testmail1 SenderDomain : domain.com SenderName : SupportTeam SenderEmail : Not Set</dev:code> <dev:remarks> <maml:para>This example gets the alert mail configuration using the connection object as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $mailSetting = $connection | Get-HPEOAAlertmail PS C:\> $mailSetting IP : 192.168.10.11 Hostname : wxyz.domian.com StatusType : OK StatusMessage : OK Status : Enabled Email : testmail.abc@xyz.com SMTPServer : testmail1 SenderDomain : Not Set SenderName : SupportTeam SenderEmail : support.team@abcdomain.com</dev:code> <dev:remarks> <maml:para>This example gets the alert mail configuration using the connection object as pipline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEOAAlertmail</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> </helpItems> |