When enabled, the System ROM reports the proximity relationship between I/O devices and system memory to the operating system. Most operating systems can use this information to efficiently assign memory resources for devices, such as network controllers and storage devices. Additionally, certain I/O devices might not be able to take advantage of I/O handling benefits if their OS drivers are not properly optimized to support this feature. See your operating system and I/O device documentation for more details.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
The ACPI SLIT (System Locality Information Table) defines the relative access times between processors, memory subsystems, and I/O subsystems. Operating systems that support the SLIT can use this information to improve performance by allocating resources and workloads more efficiently.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to disable the processor Adjacent Sector Prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enter the administrator password to protect the server configuration. When this option is enabled, you are prompted for this password before being allowed to modify the configuration.
JSON type:
Password
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure additional memory protection with ECC (Error Checking and Correcting). Options and support vary per system. Advanced ECC keeps all installed memory available for use while still protecting the system against all single-bit failures and certain multi-bit failures. Online Spare Memory enables a system to automatically map out a group of memory that is detected to be at an increased risk of receiving uncorrected memory errors based on an advanced analysis of corrected memory errors. The mapped out memory is automatically replaced by a spare group of memory without interrupting the system. Mirrored Memory provides the maximum protection against uncorrected memory errors that might otherwise result in a system failure. Lockstep Mode with DDDC Support keeps all installed memory available for use while error corrections are performed in cases of multiple DRAM device failures. This support enables protection beyond Advanced ECC. Enabling this option might impact memory performance.
JSON type:
String containing one of the following supported values:
"AdvancedEcc"
"OnlineSpareAdvancedEcc"
"MirroredAdvancedEcc"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
When Automatic Server Recovery is enabled, you can use this option to set the time to wait before rebooting the server in the event of an operating system crash or server lockup.
JSON type:
String containing one of the following supported values:
"10"
"15"
"20"
"30"
"5"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure the server to automatically power on when AC power is applied to the system. By default, the system returns to its previous power state when AC power is restored after an AC power loss. This option causes the system to always returns to the "on" state whenever power is applied, even if the system is in the "off" state when power is lost.
JSON type:
String containing one of the following supported values:
"AlwaysPowerOn"
"AlwaysPowerOff"
"RestoreLastState"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to select the boot mode of the system. Selecting UEFI Mode configures the system to boot Unified Extensible Firmware Interface (UEFI) compatible operating systems. Selecting Legacy BIOS Mode configures the system to boot traditional operating systems in Legacy BIOS compatibility mode. The operating system can only boot in the mode in which it is installed. The following options require booting in UEFI Boot Mode: Secure Boot, IPv6 PXE Boot, boot > 2.2 TB Disks in AHCI SATA Mode, and Dynamic Smart Array RAID.
JSON type:
String containing one of the following supported values:
"Uefi"
"LegacyBios"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure how the system attempts to boot devices per the Boot Order when no bootable device is found. If configured to "Retry Boot Order Indefinitely," the system continuously attempts to process the Boot Order until a bootable device is found. If configured to "Attempt Boot Order Once," the system attempts to process all items in the Boot Order once. If configured for "Reset After Failed Boot Attempt," the system attempts to process all items in the Boot Order once, and then reboots the system.
JSON type:
String containing one of the following supported values:
"RetryIndefinitely"
"AttemptOnce"
"ResetAfterFailed"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
You can only configure this option if the Power Profile is set to Custom. Use this option to modify the level of interleaving for which the memory system is configured. Typically, higher levels of memory interleaving result in maximum performance. However, reducing the level of interleaving can result in power savings.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"CollabPowerControl" : Collaborative Power Control
For operating systems that support the Processor Clocking Control (PCC) Interface, enabling this option enables the Operating System to request processor frequency changes even if the Power Regulator option on the server configured for Dynamic Power Savings Mode. For Operating Systems that do not support the PCC Interface, or when the Power Regulator Mode is not configured for Dynamic Power Savings Mode, this option has no effect on system operation.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to select the level of Consistent Device Naming. On supported operating systems, NIC ports are named based on their location in the system. CDN Support for LOMs Only names Embedded NICs and FlexibleLOMs. Existing NIC connections retain their name until reinstalled under the OS environment.
JSON type:
String containing one of the following supported values:
"LomsOnly"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This option controls the Daylight Savings Time (DST) adjustment to the displayed Local time. If this option is disabled, the displayed local time will not be adjusted for DST. If this option is enabled, the displayed local time will be advanced by one hour.
JSON type:
String containing one of the following supported values:
"Disabled"
"Enabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to disable the processor DCU IP Prefetcher feature. In some cases, setting this option to disabled can improve performance. In most cases, the default value of enabled provides optimal performance. Only disable this option after performing application benchmarking to verify improved performance in the environment.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to disable the processor DCU Stream Prefetcher feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in your environment.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
When enabled, this option enables obtaining the pre-boot network IPv4 configuration from a DHCP server. Individual settings are not available. When disabled, you must configure static IP address settings individually.
JSON type:
String containing one of the following supported values:
HTTP Operations
"DynamicPowerCapping" : Dynamic Power Capping Functionality
Use this option to configure when the System ROM executes power calibration during the boot process. In Auto mode, calibration is run the first time the server is booted and is then only run again when the server's hardware configuration or configuration settings change. When disabled, the calibration does not run and Dynamic Power Capping is not supported. When enabled, the calibration is run on every boot.
JSON type:
String containing one of the following supported values:
HTTP Operations
"DynamicPowerResponse" : Dynamic Power Savings Mode Response
Use this option to enable the System BIOS to control processor performance and power states depending on the processor workload. You can set the response time for switching between power states. - The Fast setting is optimal for most workloads where low latency response to an increase in processor demand is a requirement. - The Slow setting is optimal for workloads where a longer latency response to an increase in processing demand is an acceptable trade-off for reduced power consumption. Selecting this option can have a negative effect on performance, depending on the workload.
JSON type:
String containing one of the following supported values:
When Boot All Targets is selected, the UEFI BIOS will allow all valid boot targets attached to the storage controller to be made available in the UEFI Boot Order List. If Boot No Targets is selected, no boot targets from this storage controller will be made available in the UEFI Boot Order.If Boot Limit to 3 Targets is selected, 3 boot targets attached to the storage controller will be made available in the UEFI Boot Order.
JSON type:
String containing one of the following supported values:
When configured for Auto mode, the external video connection to the embedded video controller is automatically disabled to save power when a monitor is not attached. It is automatically enabled when a monitor is attached, including when the server is operating. When configured for Always Disabled, the external video connection to the embedded video controller is disabled and a monitor connected to this port does not display except during system boot. This can be used for security reasons. When configured for Always Enabled, the external video connection to the embedded video controller is always enabled. This option is only required if a monitor is attached with a monitor detection that does not function properly (making AUTO mode not work properly). Note: This option does not affect Integrated Remote Console video. Also, if you press F9 or F11 during system boot, the configured video connector behavior is overridden and the video console remains enabled. This lets you reconfigure the Embedded Video Connection option even if the video is disabled.
JSON type:
String containing one of the following supported values:
Use this option to enable or disable Embedded Diagnostics functionality. If disabled, you cannot launch Embedded Diagnostics. Enable this option to use the Embedded Diagnostics functionality.
JSON type:
String containing one of the following supported values:
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Important: Dynamic Smart Array RAID is not supported when the Boot Mode is configured in Legacy BIOS Mode.
Use this option to configure the embedded chipset SATA controller. When selecting the Advanced Host Controller Interface (AHCI) or RAID (if supported), make sure the proper operating system drivers are used for proper operation.
JSON type:
String containing one of the following supported values:
"Ahci"
"Raid"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Select this option to assign the logical COM Port address and associated default resources to the selected physical serial port. The operating system can overwrite this setting.
JSON type:
String containing one of the following supported values:
"Com1Irq4"
"Com2Irq3"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable or disable the Embedded UEFI Shell. If enabled, you can launch the Embedded UEFI Shell from the pre-boot environment. When enabled, you can add the Embedded UEFI Shell to the UEFI Boot Order if the boot mode is configured for UEFI by selecting the option entitled 'Add Embedded UEFI Shell to Boot Order'. When disabled, the Embedded UEFI Shell is not available in the pre-boot environment, and you cannot add it to the UEFI boot order. The Embedded UEFI Shell is a pre-boot command line environment that you can use for scripting and running UEFI applications. It provides CLI-based commands to configure the server, update the System ROM and other firmware, and obtain system information and error logs.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to control the Embedded User Partition. The Embedded User Partition is a general purpose disk partition on non-volatile flash memory that is embedded on the system board.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure the ACPI serial port settings, which include redirecting the Windows Server Emergency Management console (EMS) through the serial port. If you select this option for redirecting EMS through a network connection, two options are available:
1) When redirecting EMS through a virtual serial port, select the value (COM1 or COM2) that corresponds to the resources assigned to the Virtual Serial Port in the System Options menu.
2) When redirecting EMS through a physical serial port, select the value (COM1 or COM2) that corresponds to the resources assigned to the embedded serial port in the System Options menu.
EMS Console is not supported at 38400 BAUD.
JSON type:
String containing one of the following supported values:
"Disabled"
"Com1Irq4"
"Com2Irq3"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
You can only configure this option if the Power Profile is set to Custom. Use this option to configure several processor subsystems to optimize the performance and power usage of the processor. Balanced Performance provides optimum power efficiency and is recommended for most environments. Maximum Performance Mode is recommended for environments that require the highest performance and lowest latency but are not sensitive to power consumption. Only use Power Savings Mode in environments that are power sensitive and can accept reduced performance.
JSON type:
String containing one of the following supported values:
"MaxPerf"
"BalancedPerf"
"BalancedPower"
"PowerSavingsMode"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable the server to operate at higher ambient temperatures than normally supported. These options are only supported with specific hardware configurations. See your server documentation before configuring the server to enable extended ambient temperature support. Improper system operation or damage to hardware components can result from enabling these options in unsupported configurations. Selecting Enabled for 40c Ambient (ASHRAE 3) enables the server to operate in environments with ambient temperatures up to 40 degrees Celsius. Selecting Enabled for 45c Ambient (ASHRAE 4) enables the server to operate in environments with ambient temperatures up to 45 degrees Celsius. Not all servers support both 40c Ambient (ASHRAE 3) and 45c Ambient (ASHRAE 4).
JSON type:
String containing one of the following supported values:
"Disabled"
"ASHRAE3"
"ASHRAE4"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
When enabled, the system validates memory during the memory initialization process. If uncorrectable memory errors are detected, the memory is mapped out and the failed DIMMs are logged to the Integrated Management Log (IML). Enabling this option can result in a significant increase in system boot time.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to change the default Fibre Channel or FCoE policy for scanning for boot targets. When configured for Scan All Targets, each installed FC/FCoE adapter scans all available targets. When configured for Scan Configured Targets Only, the FC/FCoE adapters scan only targets that are preconfigured in the devices settings. This option overrides any individual device settings configured in the device specific setup.
JSON type:
String containing one of the following supported values:
"AllTargets"
"CardConfig"
h4>HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure how the server reacts when fans fail resulting in the server not having required fans in operation. When configured for "Shutdown/Halt on Critical Fan Failures," the server cannot boot or operate when it does not have required fans operating due to one or more fan failures. When configured for "Allow Operation with Critical Fan Failures," the server can boot and operate if it does not have required fans operating due to one or more fan failures. It is recommended that you configure the Fan Failure Policy to the default state of "Shutdown/Halt on Critical Fan Failures." Operating without the required fans operating can result in damage to hardware components.
JSON type:
String containing one of the following supported values:
"Shutdown"
"Allow"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure how the server reacts when all required fans are not installed. When configured for Enable Messaging, the server displays messages and log events to the Integrated Management Log (IML) when required fans are not installed. The server can still boot and operate. When configured for Disable Messaging, the server does not display messages and log events when required fans are not installed. All indications that the server is operating without required fans are removed. It is recommended that you leave Fan Installation Requirements in the default state of Enable Messaging. Operating without the required fans can result in damage to hardware components.
JSON type:
String containing one of the following supported values:
"EnableMessaging"
"DisableMessaging"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to disable the processor HW prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This option does not impact performance. When enabled, this option exposes certain chipset devices that can be used with the Intel Performance Monitoring Toolkit.
JSON type:
String containing one of the following supported values:
"Disabled"
"Enabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
If enabled, a hypervisor or operating system supporting this option can use hardware capabilities provided by Intel's Virtualization Technology for Directed I/O. You can leave this set to enabled even if you are not using a hypervisor or an operating system that uses this option.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to set the QPI Link frequency to a lower speed. Running at a lower frequency can reduce power consumption, but can also affect system performance. You can only configure this option if two or more CPUs are present and the Power Profile is set to custom.
JSON type:
String containing one of the following supported values:
"Auto"
"MinQpiSpeed"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure the QPI topology to use fewer links between processors, when available. Changing from the default can reduce QPI bandwidth performance in exchange for less power consumption.
JSON type:
String containing one of the following supported values:
"Auto"
"SingleLink"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"IntelQpiPowerManagement" : Intel QPI Link Power Management
Use this option to place the Quick Path Interconnect (QPI) links into a low power state when the links are not being used. This lowers power usage with minimal effect on performance. You can only configure this option if two or more CPUs are present and the Power Profile is set to custom.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable or disable the Intelligent Provisioning functionality. When disabled, you are prevented from entering the Intelligent Provisioning environment by pressing F10 during server boot. You must set this option to enabled to use Intelligent Provisioning functionality.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"InternalSDCardSlot" : Internal SD Card Slot
Description
This property is a member of [HpBios Attributes](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Attributes-Resource-Type)#hpbios-attributes-resource-type)
Use this option to enable or disable the Internal SD Card Slot. When set to disabled, the SD card slot is disabled, regardless of whether an SD Card is installed or not. It will not be visible in the pre-boot environment or under the operating system.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Disabling non-posted prefetching for I/O can significantly improve performance for a small set of configurations that require a balanced mix of read/write I/O traffic (for example, configurations that include Infiniband) or multiple x16 devices that utilize max bandwidth of the PCI-e bus. Disabling this feature does, however, have a slight impact on 100% I/O read bandwidth.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to specify the pre-boot network IPv4 address. Enter a static IP addresses using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
JSON type:
String
from 0 to 15 characters in length.
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to specify the pre-boot network gateway IPv4 address. Enter a static IP addresses using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
JSON type:
String
from 0 to 15 characters in length.
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to specify the pre-boot network Primary DNS Server IPv4 address. Enter a static IP addresses using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
JSON type:
String
from 0 to 15 characters in length.
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to specify the pre-boot network Secondary DNS Server IPv4 address. Enter a static IP addresses using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
JSON type:
String
from 0 to 15 characters in length.
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to specify the pre-boot network subnet mask. Enter a static IP addresses using dotted-decimal notation (for example, 255.255.255.0). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
JSON type:
String
from 0 to 15 characters in length.
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to control the IPv6 DHCP Unique Identifier (DUID). If configured for Auto, the DUID is set using the server's Universal Unique Identifier (UUID), or using the DUID-LLT method if the server UUID is not available. If configured for DUID-LLT, the DUID is set based on Link-layer Address Plus Time [DUID-LLT] method. You can configure this option only when Boot Mode is set to UEFI.
JSON type:
String containing one of the following supported values:
"Auto"
"DuidLlt"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
You can only configure this option if the Power Profile is set to Custom. Use this option to configure the memory system to run memory at a lower maximum speed than that supported by the installed processor and DIMM configuration. Setting this option to Auto configures the system to run memory at the maximum speed supported.
JSON type:
String containing one of the following supported values:
"Auto"
"2133"
"1867"
"1600"
"1333"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
You can only configure this option if the Power Profile is set to Custom. If a PCI Express device does not run properly at its optimal speed, lowering the speed at which the device is running can address this issue. This option enables you to lower the maximum PCI Express speed at which the server allows PCI Express devices to operate. You can also use it to address issues with problematic PCI Express devices. Setting this value to Maximum Supported configures the platform to run at the maximum speed supported by the platform or the PCIe device, whichever is lower.
JSON type:
String containing one of the following supported values:
"MaxSupported"
"PcieGen1"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure memory training on server reboots. When enabled, the platform uses the previously saved memory training parameters determined from the last cold boot of the server, which improves the server boot time. When disabled, the platform performs a full-memory training on every server reboot.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"MinProcIdlePkgState" : Minimum Processor Idle Power Package C-State
You can configure this option only if the Power Profile is set to Custom. Use this option to select the lowest idle package power state (C-state) of the processor. The processor automatically transitions into package C-states based on the Core C-states in which cores on the processor have transitioned. The higher the package C-state, the lower the power usage of that idle package state. (Package C6 (retention) is the lowest power idle package state supported by the processor).
JSON type:
String containing one of the following supported values:
"C6Retention"
"C6NonRetention"
"NoState"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"MinProcIdlePower" : Minimum Processor Idle Power Core C-State
You can only configure this option if Power Profile is set to Custom. Use this option to select the lowest idle power state (C-state) of the processor that the operating system uses. The higher the C-state, the lower the power usage of that idle state. (C6 is the lowest power idle state supported by the processor).
JSON type:
String containing one of the following supported values:
"C6"
"C3"
"C1E"
"NoCStates"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"MixedPowerSupplyReporting" : Mixed Power Supply Reporting
When enabled, the server logs a message that a mixed power supply configuration is present. When disabled, the server no longer logs messages that a mixed power supply configuration is present.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to disable the Network Boot Retry setting. By default, the System BIOS attempts to boot the Network device (such as a PXE device) up to 20 times before moving to the next IPL device.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to disable the NUMA architecture properties for the system. All operating system platforms support NUMA architectures. In most cases, optimum performance is obtained by disabling the Node Interleaving option. When this option is enabled, memory addresses are interleaved across the memory installed for each processor. Some workloads might experience improved performance when this option is enabled.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure how the System ROM reports the size of a NUMA node (number of logical processors), which assists the Operating System in grouping processors for application use (referred to as Kgroups). The default setting of Clustered provides better performance due to the resulting groups being optimized along NUMA boundaries. However, some applications might not be optimized to take advantage of processors spanning multiple groups. In such cases, selecting the Flat option might be necessary in order for those applications to utilize more logical processors.
JSON type:
String containing one of the following supported values:
"Clustered"
"Flat"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This option controls whether the system will wait during system boot for batteries to charge if sufficient battery backup power for the installed NVDIMMs of type NVDIMM-N is not available. If this option is configured for “Continue Boot without Backup Power”, the server will boot even if sufficient battery backup power is not installed. In this case, if sufficient battery backup power is not enabled, the installed NVDIMMs of type NVDIMM-N will NOT be used by the operating system as persistent storage or as system memory.
JSON type:
String containing one of the following supported values:
"WaitForBackupPower"
"BootWithoutBackupPower"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This option controls whether NVDIMM-N functionality (including backing up the contents of the memory to flash on power down/reset) is enabled. If this option is configured for Disabled, then the NVDIMMs of type NVDIMM-N in the system will NOT be used by the operating system as persistent storage and will NOT be used by the operating system as system memory.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This option is ONLY available if ALL NVDIMMs of type NVDIMM-N in the system were Sanitized/Erased in the previous boot. This option controls whether the NVDIMMs of type NVDIMM-N installed on a particular processor will be interleaved with each other in the memory map. This option does NOT impact the interleaving of standard DIMMs, and interleaving is never enabled across NVDIMMs of type NVDIMM-N and standard DIMMs. NVDIMMs of type NVDIMM-N installed on different processors are never interleaved together. To change this option, you must first Sanitize/Erase ALL NVDIMMs of type NVDIMM-N in the system and then modify the interleave setting after the next reboot.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"NvDimmNSanitize": NVDIMM-N Sanitize/Erase on Next Reboot Policy
This option is used to Sanitize/Erase all user data and error status data saved in the selected NVDIMMs of type NVDIMM-N. Selected NVDIMMs of type NVDIMM-N will be sanitized/erased on the next reboot of the system. This process is required BEFORE the NVDIMM-N Memory Interleaving option can be modified. An NVDIMM-N must be sanitized/erased before it can be installed in a different system or installed in a different DIMM slot on this system. In addition, an NVDIMM-N can be restored to operation if it has received an Uncorrectable Memory Error, a Backup Error, a Restore Error, or an Arming Error (if the NVDIMM hardware is functional). Note that the largest group of NVDIMMs of type NVDIMM-N selected will be sanitized/erased. For instance, if “Sanitize/Erase all NVDIMM-N on Processor 1” is Enabled and “Sanitize/Erase Processor 1 DIMM 8” is Disabled, all NVDIMMs of type NVDIMM-N on Processor 1 will be sanitized/erased including Processor 1 DIMM 8.
JSON type:
String containing one of the following supported values:
"Disabled"
"SanitizeAndRebootSystem"
"SanitizeAndShutdownSystem"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to disable the default PCI Bus setting where each expansion slot is provided with an extra PCI Bus number. By default, the System BIOS pads one PCI bus per expansion slot so that expansion cards with PCI-PCI bridges do not effect current bus numbering schemes. Disabling this option works around issues with certain expansion cards. It is recommended that you do not disable this option unless a specific issue is encountered.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to control the PCI Express End-to-End CRC (ECRC) policy for all installed PCIe Devices. When set to enabled, a PCI Express device that supports this option can take advantage of end-to-end CRC checking to increase the reliability of data transfers.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure the system to display the F1 key in the server POST screen. If an error is encountered, you can press the F1 key to continue with the server power-up sequence. Select one of the following options:
Delayed 20 Seconds - If an error occurs, the system pauses for 20 seconds at the F1 prompt and continues to boot the OS.
Delayed 2 Seconds - If an error occurs, the system pauses for 2 seconds at the F1 prompt and continues to boot the OS.
Disabled - If an error occurs, the system bypasses the F1 prompt and continues to boot the OS.
Note: For critical errors, the system pauses for 20 seconds at the F1 prompt, regardless of how this option is configured.
JSON type:
String containing one of the following supported values:
"Delayed20Sec"
"Delayed2Sec"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Disabling this option disables the momentary power button functionality. This option does not affect the four-second power button override or the remote power control functionality.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to delay the server from turning on for a specified time. Pressing the power button (using the Virtual Power Button), or Wake-ON LAN events, and RTC Wake-up events override the delay and immediately turn on the server. This enables staggering when servers power-up after a power loss to prevent power usage spikes.
JSON type:
String containing one of the following supported values:
"None"
"Random"
"15Sec"
"30Sec"
"45Sec"
"60Sec"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
When the server powers on, a prompt is displayed to enter a password before continuing the boot process. In the event of an ASR reboot, the Power-On Password is bypassed and the server boots normally.
JSON type:
Password
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
- Balanced Power and Performance: Provides the optimum settings to maximize power savings with minimal impact to performance for most operating systems and applications.
- Minimum Power Usage: Enables power reduction mechanisms that can negatively affect performance. This mode guarantees a lower maximum power usage by the system.
- Maximum Performance: Disables all power management options that can negatively affect performance.
JSON type:
String containing one of the following supported values:
"BalancedPowerPerf"
"MinPower"
"MaxPerf"
"Custom"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
You can only configure this option if the Power Profile is set to Custom. Use this option to configure the following Power Regulator support:
- Dynamic Power Savings Mode: Automatically varies processor speed and power usage based on processor utilization. Allows for the reduction of overall power consumption with little or no impact on performance. Does not require OS support.
- Static Low Power Mode: Reduces processor speed and power usage. Guarantees a lower maximum power usage for the system. Performance impacts are greater for environments with higher processor utilization.
- Static High Performance Mode: Processors run in their maximum power/performance state at all times regardless of the OS power management policy.
- OS Control Mode: Processors run in their maximum power/performance state at all times unless the OS enables a power management policy.
JSON type:
String containing one of the following supported values:
"DynamicPowerSavings"
"StaticLowPower"
"StaticHighPerf"
"OsControl"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to select the network interface used for pre-boot network connections. If the selected NIC has more than one port, only the first port with a network connection is used. When the selection is Auto, the system uses the first available port with a network connection.
JSON type:
String containing one of the following supported values:
"Auto"
"EmbNic"
"FlexLom1"
"PciSlot1"
"PciSlot2"
"PciSlot3"
"PciSlot4"
"PciSlot5"
"PciSlot6"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to disable processor cores using Intel's Core Multi-Processing (CMP) Technology. This option disables a specific number of the cores on each physical processor, which can reduce processor power usage and can improve performance for some applications, such as those that benefit from higher performance cores rather than more processing cores. This option also addresses issues with software that is licensed on a per-core basis. Enter a value equal to the number of enabled cores per socket.
JSON type:
Integer
from 0 to 24.
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable or disable Intel Hyperthreading. When enabled, each physical processor core operates as two logical processor cores. When disabled, each physical processor core operates as only one logical processor core. Enabling this option can improve overall performance for applications that benefit from a higher processor core count.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to protect your system against malicious code and viruses. Memory is marked as non-executable unless the location contains executable code. Some viruses attempt to insert and execute code from non-executable memory locations. Attacks are intercepted and an exception is generated. Your operating system must support this option.
Certain operating systems (including Windows 2012 and Windows 2012 R2) require this option to be enabled and override this setting. See your operating system documentation for more details.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Turbo Boost Technology enables the processor to transition to a higher frequency than the processor's rated speed if the processor has available power and is within temperature specifications. Disabling this option reduces power usage and also reduces the system's maximum achievable performance under some workloads.
JSON type:
String containing one of the following supported values:
"Disabled"
"Enabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
When enabled, a hypervisor or operating system supporting this option can use hardware capabilities provided by Intel's Virtualization Technology. Some hypervisors require thatyou enable Virtualization Technology. You can leave this set to enabled even if you are not using a hypervisor or an operating system that uses this option.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
x2APIC support enables operating systems to run more efficiently on high core count configurations. It also optimized interrupt distribution in virtualized environments. In most cases, set this option to enabled. This configures the operating system to optionally enable x2APIC support when it loads. Some older hypervisors and operating systems might have issues with optional x2APIC support, in which case disabling x2APIC might be necessary to address those issues. Additionally, some hypervisors and operating systems will not use X2APIC unless this option is set to Force Enabled prior to booting. The Force Enabled option also causes the Intel(R) VT-d setting to be set to enabled.
JSON type:
String containing one of the following supported values:
"Enabled"
"ForceEnabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
The QPI link between two processors provides the best performance for most applications. The Balanced option provides the best performance for most applications and benchmarks. The optimized for I/O option can increase bandwidth from I/O devices, such as GPUs that rely on direct access to system memory. This option is only configurable if two or more CPUs are present.
JSON type:
String containing one of the following supported values:
"Balanced"
"OptimizedForIo"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to select the snoop mode used by the processor and QPI bus. Changing this option can have an impact on memory performance. The Home Snoop option provides high-memory bandwidth in an average NUMA environment. The Cluster on Die option can provide increased memory bandwidth in highly optimized NUMA workloads. The Early Snoop option can decrease memory latency, but can also result in lower overall bandwidth as compared to the other modes.
JSON type:
String containing one of the following supported values:
"Standard"
"EarlySnoop"
"ClusterOnDie"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"RedundantPowerSupply" : Redundant Power Supply Mode
Use this option to configure how the system handles redundant power supply configurations. Balanced Mode shares the power delivery equally between all installed power supplies. All High Efficiency Mode options provide the most power efficient operation with redundant power supplies by keeping half of the power supplies in standby mode at lower power usage levels. The High Efficiency Mode options enable the system to select which power supply to place in standby. Auto enables the system to select between the odd or even power supply based on a semi-random distribution within a group of systems.
JSON type:
String containing one of the following supported values:
"BalancedMode"
"HighEfficiencyAuto"
"HighEfficiencyOddStandby"
"HighEfficiencyEvenStandby"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"RemovableFlashBootSeq" : Removable Flash Media Boot Sequence
Use this option to select which USB or SD Card devices you want to search for first when enumerating boot devices. You can select whether the systemboots to external USB drive keys, internal USB drive keys, or the internal SD card slot. This option does not override the device boot order in the Standard Boot Order (IPL) option. You can only configure this option when Boot Mode is set to Legacy BIOS.
JSON type:
String containing one of the following supported values:
"InternalSdCardFirst"
"InternalKeysFirst"
"ExternalKeysFirst"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"RestoreDefaults": Restore Default System Settings
Use this option to reset all configuration settings to their default values. Changes that have been made might be lost. You need to reboot the system for changes to take effect.
JSON type:
String containing one of the following supported values:
"No"
"Yes"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to reset all configuration settings to their default manufacturing values. Changes that have been made might be lost. If Secure Boot is enabled, related security settings might be lost. You need to reboot the system for changes to take effect.
JSON type:
String containing one of the following supported values:
"No"
"Yes"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This property is a member of [HpBios Attributes](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Attributes-Resource-Type)#hpbios-attributes-resource-type)
When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This property is a member of [HpBios Attributes](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Attributes-Resource-Type)#hpbios-attributes-resource-type)
When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
When Enabled, all user data in ALL NVDIMMs of type NVDIMM-N installed on the selected processor will be erased on the next reboot.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"SataSecureErase" : SATA Secure Erase
Description
This property is a member of [HpBios Attributes](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpBios-Attributes-Resource-Type)#hpbios-attributes-resource-type)
Use this option to control whether Secure Erase functionality is supported. When enabled, the Security Freeze Lock command is not sent to supported SATA hard drives, enabling Secure erase to function (the Secure Erase command is supported). This option is only supported when the SATA controller is in AHCI mode. Secure Erase only operates with hard drives that support the Secure Erase command.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to select the emulation mode type. The option you select depends on the emulation you want to use in your serial terminal program (such as Hyperterminal or Putty). The BIOS emulation mode must match the mode you select in your terminal program.
JSON type:
String containing one of the following supported values:
"Vt100"
"Ansi"
"Vt100Plus"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to re-direct video and keystrokes through the serial port to OS boot. This option can interfere with non-terminal devices attached to the serial port. In such cases, set this option to Disabled. This option is only supported in English language mode when running in the UEFI pre-boot System Utilities.
JSON type:
String containing one of the following supported values:
"Auto"
"Disabled"
"Physical"
"Virtual"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.
JSON type:
String containing one of the following supported values:
"NetworkBoot"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
When Boot All Targets is selected, the UEFI BIOS will allow all valid boot targets attached to the storage controller to be made available in the UEFI Boot Order List. If Boot No Targets is selected, no boot targets from this storage controller will be made available in the UEFI Boot Order.If Boot Limit to 3 Targets is selected, 3 boot targets attached to the storage controller will be made available in the UEFI Boot Order.
JSON type:
String containing one of the following supported values:
"AllTargets"
"ThreeTargets"
"NoTargets"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
If enabled, SR-IOV support enables a hypervisor to create virtual instances of a PCI-express device, potentially increasing performance. If enabled, the BIOS allocates additional resources to PCI-express devices. You can leave this option set to enabled even if you are not using a hypervisor.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to select the fan cooling solution for the system. Optimal Cooling provides the most efficient solution by configuring fan speeds to the minimum required speedto provide adequate cooling. Increased Cooling runs fans at higher speeds to provide additional cooling. Select Increased Cooling when third-party storage controllers are cabled to the embedded hard drive cage, or if the system is experiencing thermal issues that cannot be resolved. Maximum cooling provides the maximum cooling available on this platform.
JSON type:
String containing one of the following supported values:
"OptimalCooling"
"IncreasedCooling"
"MaxCooling"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to control the reaction of the system to caution level thermal events. When disabled, the System Management Firmware ignores thermal events and the system immediately powers off in data-destructive situations.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This option controls how the system time is stored in the hardware Real Time Clock (RTC). When configured to 'Coordinated Universal Time (UTC)' (default) the local time is calculated from the associated time zone value. When configured to 'Local Time' the time is stored directly as local time and the time zone option does not have meaning. Setting this option to 'Local Time' works around an issue when using Microsoft Windows operating systems in Legacy Boot Mode where the time is set incorrectly.
JSON type:
String containing one of the following supported values:
"Utc"
"Local"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable the Trusted Module (TM) and BIOS secure startup. When enabled, the TM is fully functional. When disabled, the TM is visible; however, functionality is limited. This option also enables you to reset the TM to factory settings, which clears any assigned passwords, keys, or ownership data. Clearing the TM can prevent the server from booting to a TM-aware operating system if the operating system uses TM's measurements.
JSON type:
String containing one of the following supported values:
"NoAction"
"Enable"
"Disable"
"Clear"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to hide the Trusted Module (TM) from the operating system. When the TM is hidden, BIOS secure startup is disabled, and the TM does not respond to any commands. Intended use is for removing the TM option from the system without removing the actual hardware.
JSON type:
String containing one of the following supported values:
"Hidden"
"Visible"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to perform a clear operation on the TPM. Clearing the TPM can prevent the server from booting to a TPM-aware operating system if the operating system uses TPM's measurements. TPM 2.0 is supported only in UEFI Boot Mode.
JSON type:
String containing one of the following supported values:
"NoAction"
"Clear"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to control Physical Presence Interface for TPM 2.0 operation. This option is used to control whether the user is prompted during the next boot after a TPM 2.0 operation request was initiated by the Operating System. When TPM 2.0 Physical Presence Confirmation is Enabled, the system will prompt for confirmation during POST. When TPM 2.0 Physical Presence Confirmation is Disabled, the system will not prompt for confirmation during POST.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to hide TPM from the operating system. When the TPM is hidden, BIOS secure startup is disabled, and the TPM does not respond to any commands. Intended use is for removing the TPM option from the system without removing the actual hardware. TPM 2.0 is only supported in UEFI boot mode.
JSON type:
String containing one of the following supported values:
"Hidden"
"Visible"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to bind the TPM module to the system board by using a value that is unique to each server board. This option ensures that the TPM measurement in PCR[0] is unique for every server regardless of hardware and firmware configuration.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable the Trusted Platform Module and BIOS secure startup. When enabled, the TPM is fully functional. When disabled, the TPM is visible; however, functionality is limited. This option also enables you to reset the TPM to factory settings, which clears any assigned passwords, keys, or ownership data. Clearing the TPM can prevent the server from booting to a TPM-aware operating system if the operating system uses TPM's measurements.
JSON type:
String containing one of the following supported values:
"NoAction"
"Enable"
"Disable"
"Clear"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to hide TPM from the operating system. When the TPM is hidden, BIOS secure startup is disabled, and the TPM does not respond to any commands. Intended use is for removing the TPM option from the system without removing the actual hardware.
JSON type:
String containing one of the following supported values:
"Hidden"
"Visible"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
When enabled, the System BIOS boots using native UEFI graphics drivers. When disabled, the System BIOS boots using INT10 legacy video support. You cannot disable this option if Secure Boot is enabled. You can only configure this option if Boot Mode is configured to UEFI.
Set this option to disabled for compatibility with Microsoft Windows 2008 and Windows 2008 R2 operating systems on a system configured for UEFI Boot Mode.
Set this option to enabled for compatibility with VMWare ESXi operating systems on a system configured for UEFI Boot Mode.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to control the ordering of network boot targets in the UEFI Boot Order list.
If configured for Auto, the order of the existing network boot targets is not modified in the UEFI Boot Order list. New network boot targets are added to the end of the list using the default policy of the System ROM.
If configured for IPv4 then IPv6, the UEFI Boot Order is modified to list all existing IPv4 targets before any existing IPv6 targets. New network boot targets will have IPv4 targets added before IPv6 targets.
If configured for IPv6 then IPv4, the UEFI Boot Order is modified to list all existing IPv6 targets before any existing IPv4 targets.
If configured for IPv4, all existing IPv6 network boot targets are removed in the UEFI Boot Order. No new IPv6 network boot targets are added to the list.
If configured for IPv6, all existing IPv4 network boot targets in the UEFI Boot Order are removed. No new IPv4 network boot targets are added to the list.
When modifying these settings, changes to the UEFI Boot Order are not reflected until you reboot the system. You can configure this option only when Boot Mode is set to UEFI.
JSON type:
String containing one of the following supported values:
"Auto"
"IPv4ThenIPv6"
"IPv4"
"IPv6"
"IPv6ThenIPv4"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"UefiShellBootOrder" : Add Embedded UEFI Shell to Boot Order
When enabled, this option adds the Embedded UEFI Shell as an entry in the UEFI Boot Order list. This option is only available when the Boot Mode is configured as UEFI, and the Embedded UEFI Shell is enabled.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to enable or disable automatic execution of the Embedded UEFI Shell startup script. You can store the script file on local media or access it from a network location. The script file must be named "startup.nsh" and must be placed on local media or a network location accessible to the server.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to select the location of the Embedded UEFI Shell startup script. For the 'File Systems on Attached Media' option, you must name the script file "startup.nsh" and place it on a UEFI accessible local file system, such as a FAT32 partition on a USB disk or HDD. For the 'Network Location' option, the file must end with a .nsh extension, and must be placed at an HTTP or FTP location accessible to the server. When you select the 'Auto' option, the system attempts to retrieve the startup script from the network location first, followed by locally attached media.
JSON type:
String containing one of the following supported values:
"Auto"
"AttachedMedia"
"NetworkLocation"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"UefiShellStartupUrl" : Network Location for Shell Auto-Start Script
Use this option to configure a network URL to a UEFI Shell startup script. URLs in HTTP or FTP formats are accepted using either an IPv4 server address or host name. For example, this can be http://192.168.0.0/file/file.nsh or http://example.com/file/file.nsh. IPv6 server addresses are not supported. The file must end with an .nsh extension. When configured, the Embedded UEFI Shell attempts to load and execute the startup script from the network location pointed to by this URL.
JSON type:
String
from 0 to 255 characters in length.
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure a network URL to a bootable ISO or EFI file. URLs in HTTP or FTP formats are accepted using either an IPv4 server address or host name. For example, this can be http://192.168.0.0/file/image.iso or http://example.com/file/image.efi. IPv6 server addresses are not supported. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting the boot option downloads the file to the system memory and attempts booting from it. This setting requires configuring the pre-boot network settings to access the URL location. It is supported only in UEFI boot mode.
Note: Booting from an ISO file is limited to files that enable the system to boot a preliminary OS environment (such as WinPE or a mini Linux) where further installation can proceed over an OS network connection. ISO files that contain the full OS installation media are not supported.
JSON type:
String
from 0 to 254 characters in length.
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure the operating mode of the USB 3.0 ports. If set to Auto Mode, USB 3.0 capable devices operate at USB 2.0 speeds in the pre-boot environment and during boot. When a USB 3.0 capable OS USB driver loads, USB 3.0 devices transition to USB 3.0 speeds. This mode provides compatibility with operating systems that do not support USB 3.0, while enabling USB 3.0 devices to operate at USB 3.0 speeds with current operating systems. If enabled, USB 3.0 capable devices operate at USB 3.0 speeds at all times (including the pre-boot environment) when in UEFI Boot Mode. Do not use this mode with operating systems that do not support USB 3.0. If operating in Legacy Boot Mode, the USB 3.0 ports do not function in the pre-boot environment, and are not bootable. If set to disabled, USB 3.0 capable devices function at USB 2.0 speeds at all times.
JSON type:
String containing one of the following supported values:
"Auto"
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Set this option to disabled to prevent the system from booting to any USB devices connected to the server. This includes preventing boot to virtual media devices and the embedded SD or uSD card slot (if supported).
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to configure video settings in the system. When set to Add-in Video Enabled, Embedded Video Disabled, the system only displays video to the first discovered add-in video controller. When set to Both Add-in and Embedded Video Enabled, the system displays video to both the embedded and the first discovered add-in video controllers. In both modes, early system startup video is displayed to the embedded video controller.
JSON type:
String containing one of the following supported values:
"OptionalVideoOnly"
"BothVideoEnabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to control the Virtual Install Disk. The Virtual Install Disk contains drivers specific to this server that an OS can use during installation. If enabled, the Virtual Install Disk appears as a drive in the operating system.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to assign the logical COM port address and associated default resources used by the Virtual Serial Port (VSP). VSP enables the Management Processor topresent an emulated serial port to support the BIOS Serial Console and operating system serial console.
JSON type:
String containing one of the following supported values:
"Com1Irq4"
"Com2Irq3"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Use this option to set the global VLAN ID for all enabled network interfaces. Possible values are 0 to 4094.A value of 0 indicates that the device will send untagged frames.
JSON type:
Integer
from 0 to 4094.
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
You can configure the server to be powered on remotely when it receives a special packet. This option requires a NIC, NIC driver, and operating system that are WOL-capable.
JSON type:
String containing one of the following supported values:
"Enabled"
"Disabled"
HTTP Operations
GET
Rendered if supported by the implementation or omitted if not.
PATCH
This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.