Set-OVServerOneTimeBoot
Syntax
Set-OVServerOneTimeBoot
[-InputObject] <Object>
[-Setting] <String>
[-ApplianceConnection <Object>]
[-PowerOn]
[<CommonParameters>]
Description
HPE OneView allows you to set a one-time boot option for the server hardware. You can set the one-time boot option to any of the following:
- Keep current settings—Keeps the previously chosen settings.
- No one-time boot—Normal boot is used when this option is selected.
- PXE—Boots from the PXE server on the network.
- Hard disk—Boots from the first local disk.
- CD—Boots from a local or virtual optical drive.
- USB—Boots from a physical or virtual USB drive.
Other one-time boot options are available through the HPE iLO interface; however, HPE OneView offers only a common subset of one-time boot options. The one-time boot option requires the server hardware to be powered off and powered back on. If you set the one-time boot option while the server power is on, the one-time boot value is remembered until the server is powered off and then powered back on. HPE OneView does not support setting of the one-time boot option while the server is in power-on self-test (POST).
After setting the one-time boot option, when the server hardware is powered off and powered on, HPE iLO attempts to boot the server using the selected boot option. If the selected boot option is not available, HPE iLO attempts to boot the server using the boot order defined in the server profile. After using or attempting to use the one-time boot value, the one-time boot value is reset to No one-time boot and the server boots using the boot order defined in its server profile or through HPE iLO.
Info
Minimum required privileges: Server administrator
Examples
Example 1
Set the specific server to PXE boot.
Example 2
Get-OVServer -Name MyServer* | ? powerState -eq On | Stop-OVServer -Confirm:$false
Get-OVServer -Name MyServer* | Set-OVServerOneTimeBoot -Setting PXE -PowerOn
Power off the servers that need to be powered off. The set those servers to PXE boot and power on.
Example 3
Set the specified server to boot normally, clearing the one time boot value.
Parameters
-ApplianceConnection <Object>
Specify one or more [HPEOneView.Appliance.Connection] object(s) or Name property value(s).
| Aliases | Appliance |
|---|---|
| Required? | False |
| Position? | Named |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | False |
-Confirm <SwitchParameter>
| Aliases | cf |
|---|---|
| Required? | True |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-InputObject <Object>
The server hardware or server profile resource object from Get-OVServer or Get-OVServerProfile. If providing a server profile resource, it must be assigned to a server in order for one time boot settings to be returned.
| Aliases | Server |
|---|---|
| Required? | True |
| Position? | Named |
| Default value | |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | False |
-PowerOn <SwitchParameter>
If the server is already powered off, instruct OneView to power on the server once the one time boot setting has been applied.
| Aliases | PowerState |
|---|---|
| Required? | True |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Setting <String>
The intended one time boot setting. Allowed values:
- Normal - Normal boot, or to disable one time boot on a server that has a different value set.
- PXE - Network boot from the default PXE adapter device.
- HDD - instruct the server to find the first bootable disk drive.
- CD - instruct the server to boot from an available CD/DVD drive, including iLO Virtual Media
- USB - boot from a USB removal storage device.
| Aliases | None |
|---|---|
| Required? | True |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-WhatIf <SwitchParameter>
| Aliases | wi |
|---|---|
| Required? | True |
| 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
Server hardware resource object from Get-OVServer.
Server profile resource object from Get-OVServerProfile.
Return Values
Asynchronous task resource to monitor.