Set-OVComposerIlo
Syntax
Set-OVComposerIlo
[-InputObject] <Object>
[-Username <String>]
[-Password <SecureString>]
[-IPv4Address <IPAddress>]
[-IPv4SubnetMask <String>]
[-IPv4Gateway <IPAddress>]
[-IPv4DnsServer <IPAddress[]>]
[-IPv6Address <IPAddress>]
[-IPv6SubnetMask <String>]
[-IPv6Gateway <String>]
[-IPv6DnsServer <IPAddress[]>]
[-IloHostname <String>]
[-Async]
[-ApplianceConnection <Object>]
[<CommonParameters>]
Description
You can configure the HPE Synergy Composer2 for remote access through its embedded management processor (iLO). This configuration enables you to manage the Composer2 remotely and perform specific Composer2 management operations that previously required accessing the Composer console locally in the data center.
After remote access to a Composer2 iLO is configured, you can:
- Use the iLO Integrated Remote Console (iLO IRC) to access the Composer2 physical console. The physical console provides access to the HPE OneView maintenance console. The Composer2 iLO has an independent IPaddress and is accessible even when the Composer2 is not available.
- Mount a virtual USB drive on the Composer2 through iLO and perform critical operations such as reimage,restore, backup, and create support dump without physically accessing the appliance.
- Power on or off the appliance.
You can configure the iLO of the HPE Synergy Composer2 for remote access using this Cmdlet. All the Composer2 nodes that are present in the enclosures managed by HPE OneView can be configured, including standby or standalone Composer2 nodes. The following are the settings that you can configure for the Composer2 iLO in HPE OneView:
- The iLO user account and password that are required to log in to the Composer2 iLO.
- Network parameters that allow you to access the Composer2 iLO from an external browser. The network parameters include iLO hostname, iLO IP address, subnet mask, gateway, and DNS server names. Both IPv4 and IPv6 addresses are supported.
Supported operations on the Composer2 through the iLO Integrated Remote Console
You can perform the following operations when using the HPE Synergy Composer2 iLO Integrated Remote Console (iLO IRC):
- Switch between the graphical console or the Composer2 maintenance console. By default, the Composer2 console displays a graphical browser interface. Use Ctrl+Alt+F1 and Ctrl+Alt+F2 to switch between the graphical interface and the maintenance console.
- For the first-time setup, Hewlett Packard Enterprise recommends that you configure the appliance network before the hardware discovery process starts.
- Power on and off the appliance using the integrated power control options on the iLO remote console.
- Use the Composer2 iLO virtual media feature to have a USB drive on your local workstation mounted as a virtual USB drive on the Composer2.
Virtually mounting the USB drive allows you to:
- Reimage the Composer2 from a DD image on the virtual USB drive.
-
Create a support dump file on the virtual USB drive.
NOTE: If both virtual USB drive and local USB drive are plugged into the Composer2, by default the virtual USB drive is selected. To choose the USB drive that is plugged into the Composer2, unmount the virtual USB drive. In the iLO IRC, select Virtual Drives and clear the virtual drive selection to unmount the virtual USB drive. You can also unmount the virtual USB drive from the maintenance console of HPE OneView.
-
Restore the Composer2 from a backup image on the virtual USB drive.
Requirements
- A single iLO user account is supported. Creating a user account replaces any existing user account.
- The iLO username cannot be Administrator or start with an _.
Info
The iLO user account is assigned a predefined set of privileges that allows the user to perform a restricted set of iLO operations. Specifically, the iLO account has permissions to control power, use the iLO Integrated Remote Console (iLO IRC), and use the iLO Virtual Media.
Use this Cmdlet to change the existing iLO configuration. This Cmdlet supports changing the iLO Hostname, user account, its password, configured IPv4 or IPv6 addresses.
Info
Minimum required privileges: Infrastructure Administrator
Examples
Example 1
$UpdatedSecurePassword = Read-Host "Password" -AsSecureString
$ComposerAppliance = Get-OVComposerIloStatus
Set-OVComposerIlo -InputObject $ComposerAppliance -Hostname Myilohost.domian.com -Password $UpdatedSecurePassword
Change the existing iLO user account password to the value provided for the specific HPE Synergy Composer 2 iLO.
Example 2
$ComposerAppliance = Get-OVComposerIloStatus | Where-Object Role -eq "Active"
Set-OVComposerIlo -InputObject $ComposerAppliance -IPv4Address 10.16.1.102 -IPv4SubnetMask 23 -IPv4Gateway 10.16.0.1
Change the IPv4 address to the new value for the Active (Primary) HPE Synergy Composer 2 iLO.
Example 3
$ComposerAppliance = Get-OVComposerIloStatus | Where-Object Role -eq "Standby"
Set-OVComposerIlo -InputObject $ComposerAppliance -IPv4Address 10.16.1.103 -IPv4SubnetMask 23 -IPv4Gateway 10.16.0.1
Change the IPv4 address to the new value for the Standby (Secondary) HPE Synergy Composer 2 iLO.
Parameters
-ApplianceConnection <Object>
Specify one or more [HPEOneView.Appliance.Connection] object(s) or Name property value(s).
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Async <SwitchParameter>
Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Confirm <SwitchParameter>
| Aliases | cf |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-IPv4Address <IPAddress>
Use to specify a new IPv4 Address for the HPE Synergy Composer2 iLO.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-IPv4DnsServer <IPAddress[]>
Use to optionally set 1 or 2 IPv4 DNS Servers.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-IPv4Gateway <IPAddress>
Use to optionally specify the default gateway for the new IPv4 address.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-IPv4SubnetMask <String>
Use to optionally update the IPv4 subnet mask for the new IPv4 address. Can either be the full subnet mask in decimal noted or CIDR format.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-IPv6Address <IPAddress>
Use to specify a new IPv6 Address for the HPE Synergy Composer2 iLO.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-IPv6DnsServer <IPAddress[]>
Use to optionally set 1 or 2 IPv6 DNS Servers.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-IPv6Gateway <String>
Use to optionally specify the default gateway for the new IPv6 address.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-IPv6SubnetMask <String>
Use to optionally specify the default gateway for the new IPv6 address. Can either be the full subnet mask in colon noted or CIDR format.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-IloHostname <String>
Use to optionally specify a new iLO subsystem hostname.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-InputObject <Object>
The object from Get-OVComposerIloStatus.
| Aliases | None |
|---|---|
| Required? | True |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Password <SecureString>
Use to specify a new password for the configured iLO user account.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Username <String>
Use to specify a new account name to configure. The original account will be removed from the iLO.
| Aliases | None |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-WhatIf <SwitchParameter>
| Aliases | wi |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Input Types
The appliance hardware configuration object from Get-OVComposerIloStatus.
Return Values
Async task resource to monitor.