Dell Command | PowerShell Provider Version 1.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. Copyright © 2015 - 2017 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 Introduction..................................................................................................................... 4 Other documents you may need.........................................................................................................................................4 2 Attributes supported in Dell Command | PowerShell Provider.........................................5 AdvancedBootOptions...............................................................................
1 Introduction Dell Command | PowerShell Provider is a PowerShell module that provides BIOS configuration capability to Dell client platforms using the Windows PowerShell Interface. Dell Command | PowerShell Provider can be installed as plug-in software registered within a Windows PowerShell environment. This document describes the supported attributes, and error reporting in Dell Command | PowerShell Provider.
2 Attributes supported in Dell Command | PowerShell Provider Following are the categories in Dell Command | PowerShell Provider. These categories contain BIOS attributes. Table 1. Attributes supported in Dell Command | PowerShell Provider Category Name Description AdvancedBootOptions Displays the attributes to configure advanced boot settings. AdvancedConfigurations Displays the attributes to configure various advanced settings.
Category Name Description Wireless Displays the attributes to configure wireless devices. AdvancedBootOptions Table 2. AdvancedBootOptions Attribute Name Description AttemptLegacyBoot Determines if BIOS should attempt to boot from the legacy boot list when the UEFI boot list fails. Possible values: • • LegacyOrom Enabled - If the UEFI boot list fails, then BIOS attempts to boot from the Legacy boot list. Disabled - BIOS discontinues the booting process if the UEFI boot list fails.
BatteryInformation Table 4. BatteryInformation Attribute Name Description PercentCharged Displays the charged percentage of the battery. Possible values: Read-only BIOSSetupAdvancedMode Table 5. BIOSSetupAdvancedMode Attribute Name Description AdvancedMode Enabling BIOS Setup Advanced Mode makes all BIOS settings visible. Possible values: • • Enabled Disabled BootSequence Table 6. BootSequence Attribute Name Description BootList Determines the system’s boot mode.
Attribute Name Description NOTE: You cannot set the Enclave Reserve Memory Size using the Dell Command | PowerShell Provider. One of the methods of setting Enclave Reserve Memory Size is from the BIOS setup screen. Configures Software Guard Extensions (SGX) feature. You can select Enabled or SoftControlled if this option is disabled.
Attribute Name Description • BiosAutoRcvr Disabled — Restricts the system to downgrade the system BIOS. Enables or disables BIOS auto recovery feature. Possible values: • • Enabled — If BIOS corruption is detected, the system automatically recovers BIOS without any user interaction. Disabled — Disables BIOS auto recovery feature. NOTE: You can enable this option only if BiosRcvrFrmHdd option is enabled. BiosIntegrityCheck Enables or disables the BIOS integrity check during the booting process.
Attribute Name Description DIMMDSize Displays the amount of main memory physically installed in the DIMM slot D. Possible Values: Read-only MemoryAvailable Displays the amount of main memory available to the operating system. NOTE: Due to an amount of memory allocated for the system use, MemoryAvailable is less than MemoryInstalled. Certain operating systems may not be able to use all the available memory.
Attribute Name Description ExpressCard Enables or disables the ExpressCard. Possible values: • • HdFreeFallProtect Enabled Disabled Enables or disables hard drive free fall protection. Possible values: • • MediaCard Enabled Disabled Enables or disables the media card. If disabled, the media card is hidden from the OS and not seen in the Device Manager. Possible values: • • MediaCardand1394 Enabled Disabled Enables or disables the media card and 1394.
Attribute Name Description Possible values: • • PCMCIA Enabled Disabled Enables or disables the PCMCIA device slot. Possible values: • • SdCard Enabled Disabled Enables or disables the SD card slot. Possible values: • • SdCardBoot Enabled Disabled Enables or disables booting the system from an SD card. Possible values: • • SdCardReadOnly Enabled — Allows the system to boot from an SD card. Disabled — Prevents the system from detecting or boot from the SD card.
Attribute Name Description • • • • • • • • • • CpuSnoopMode Cores7 — Seven cores are enabled. Cores8 — Eight cores are enabled. Cores9 — Nine cores are enabled. Cores10 — Ten cores are enabled. Cores11 — Eleven cores are enabled. Cores12 — Twelve cores are enabled. Cores13 — Thirteen cores are enabled. Cores14 — Fourteen cores are enabled. Cores15 — Fifteen cores are enabled. Cores16 — Sixteen cores are enabled. Configures the CPU snoop mode.
Attribute Name Description • IntelRapidStart Disabled Enables or disables the Intel Rapid Start feature. The Intel Rapid Start feature reduces power consumption by putting the system into a low-power state during sleep mode after the specified amount of time (minutes). The resume time may be slightly more than resuming the system from a sleep mode, but less than resuming from a hibernate mode.
Attribute Name Description • • • NodeInterleave Cores12 — Twelve cores are enabled. Cores14 — Fourteen cores are enabled. Cores16 — Sixteen cores are enabled. Enables or disables memory interleave mode. Possible values: • • Speedstep Enabled Disabled Intel SpeedStep technology that allows the processor to operate at two or more operating speeds called P-states in ACPI terminology. When disabled, the processor operates at its maximum frequency.
Attribute Name Description • • Fastboot 5s — Delays for 5 seconds. 10s — Delays for 10 seconds. Controls specific steps performed during boot to decrease boot time or increase boot checks. This option can speed up the boot process by bypassing some compatibility steps. Possible values: • • • Minimal — Reduces boot time by skipping certain hardware and configuration initialization during boot. Thorough — Performs complete hardware and configuration initialization during boot.
Attribute Name Description Possible values: • • • • PostF12Key SerialMouse — Uses a serial mouse and disables the internal touchpad. Ps2Mouse — Disables the integrated touchpad when an external PS2 mouse is present. Touchpad — Leave the integrated touchpad enabled when an external PS2 mouse is present. SwitchToExternalPS2 — Sets the pointing device to switch to external ps2. Enables or disables Boot Menu on POST boot screen. Possible values: • • PostF2Key Enabled — Enables F12 Boot Option Menu.
Attribute Name Description Possible values: • • • PromptWrnErr — System pauses for the user to respond when warnings or errors are detected. ContWrn — System continues to boot when warnings are detected, but pauses for the user to respond when errors are detected. ContWrnErr — System continues to boot when warnings or errors are detected. NOTE: Errors deemed critical to the operation of the system hardware always pause the system. Enables or disables the WyseP25Access feature.
Attribute Name Description AutoOn Configures the days when the system has to turn on automatically at the time specified in AutoOnHr and AutoOnMn. This function can turn on the system either every day, on weekdays, or on selected days. If AutoOnHr is set to 23, and AutoOnTime is set to 53, then setting AutoOntime to Weekdays turns on the system automatically on weekdays (Monday to Friday) at 11:53 p.m..
Attribute Name Description AutoOnFri Enables or disables the AutoOn functionality at the specified time on Fridays. Possible values: • • AutoOnSat Enabled Disabled Enables or disables the AutoOn functionality at the specified time on Saturdays. Possible values: • • BlinkPowerSupply1LED Enabled Disabled Normally, the status LEDs on the back of the Power Supply Unit (PSU) displays solid green color. Possible values: • Enabled — The first power supply (PSU 1) status LED blinks for few seconds.
Attribute Name Description Possible values: • • • DockBatteryChargeConfiguratio n Configures the dock battery charge mode. Possible values: • • FanCtrlOvrd Disabled S5Only S4AndS5 Standard — Charges the battery over a long period of time. Express — Charges the battery in Express Charge mode using Dell's fast charging technology. Runs the system fan at full speed. Possible values: • • FanSpeed Enabled Disabled Sets the speed of the fan to Auto, High, Medium, Low, Medium High, or Medium Low.
Attribute Name Description • ModBattChargeCfg Disabled — Display will not be affected when lid is closed. Configures the module bay battery charge mode. Possible values: • • PeakShiftBatteryThreshold Standard — Charges the battery at a standard rate. Express — Charges the battery faster using the express charging algorithm, Dell's fast charging technology Sets the value of the Peak Shift battery threshold. The acceptable value range is from 15 to 100 percent.
Attribute Name Description NOTE: This feature works only if the system is connected to AC power. SleepMode Determines which sleep mode to be used by the operating system. NOTE: The BIOS can only support either Modern Standby sleep mode (connected or disconnected), or S3 sleep mode. Possible values: • • SliceBattChargeCfg OSAutoSelection — Allows the operating system to select the appropriate sleep mode automatically. ForceS3 — Forces the operating system to use the S3 sleep mode only.
Attribute Name Description • • • WlanAutoSense LanWlan — Allows the system to be powered on by special LAN or wireless LAN signal. AddInCard — Allows the system to be powered on by NICs plugged into the special power connector. Onboard — Allows the system to be powered on by Onboard NIC. Enables or disables the WLAN radio when the system is connected to a wired network. When disconnected from the wired network, WLAN radio is re-enabled.
Attribute Description FaultTolerantMemLogClear Enables or disables the Fault Tolerant Memory Log Clear option. Possible values: • • Enabled — System clears fault tolerant memory log during the next boot. Disabled — Fault Tolerant Memory Log Clear option will be disabled, and no action will be taken during the next boot. NOTE: Fault Tolerant Memory Log Clear option will be reset to disabled state after log gets cleared. GpsWwan Enables or disables GPS WWAN Radio.
Attribute Description RecoveryTool Enables or disables the Dell recovery tool. Possible values: • • Enabled — Enables the Dell recovery tool. Disabled — Disables the Dell recovery tool. Deletes the service OS non-volatile region. ServiceOSClear Possible values: • • Enabled — Deletes the service OS non-volatile region and changes the token status to Disabled. Disabled — Does not delete the service OS non-volatile region. Enables or disables the USB wake from s4 power state of the system.
Attribute Name Description ProcessorL3Cache Displays the L3 cache size. Possible values: Read-only Displays the brand information of the processor installed on the system. ProcessorType Possible values: Read-only SecureBoot Table 17. SecureBoot Attribute Name Description SecureBoot Enables or disables the SecureBoot feature. For SecureBoot to be enabled, the system needs to be in UEFI boot mode, and the Enable Legacy Option ROMs option needs to be turned off.
Attribute Name Description • • ChassisIntrusionStatus Disabled — The system does not detect and report the Chassis Intrusion events to the system display on boot-up. SilentEnable — The system detects, but does not report the Chassis Intrusion events to the system display on boot-up. Displays the status of chassis intrusion. NOTE: Except TripReset, all values are read-only. Possible values: • • • • CpuXdSupport DoorOpen — Indicates that chassis door is open.
Attribute Name Description Possible values: • • Enabled — Displays the Intel Platform Trust Technology (PTT) device from the operating system on the next boot. Disabled — Hides the Intel Platform Trust Technology (PTT) device from the operating system on the next boot. NOTE: When disabled, the PTT device is not displayed to the operating system, and no changes can be made to the PTT device or its content. IsAdminPasswordSet Specifies if an admin password has been set.
Attribute Name Description Possible values: • • StrongPassword Disabled — If disabled, then the system and HDD passwords are locked by admin password and cannot be set, modified, or deleted unless admin password is provided. Enabled — If enabled, then the system and the HDD passwords can be set, modified, or deleted. Enables or disables the enforced use of a strong password.
Attribute Description StealthModeGPSReceiver Enables or disables Stealth Mode behavior for GPS receiver if the StealthMode attribute is enabled. Possible values: • • StealthModeLCD Enabled Disabled Enables or disables Stealth Mode behavior for the LCD if the StealthMode attribute is enabled. Possible values: • • StealthModeLEDs Enabled Disabled Enables or disables Stealth Mode behavior for LEDs if the StealthMode attribute is enabled.
SupportAssistSystemResolution Table 20. Attribute Description AutoOSRecoveryThreshold Sets the threshold value for auto OS recovery. Possible values: 0 to 3 Controls the automatic boot flow for SupportAssist System Resolution console and for Dell OS Recovery Tool.
Attribute Name Description DockSupportOnBattery Enabling DockSupportOnBattery allows you to use the docking station, when AC power is absent, but only when the battery is preceding a certain charge percentage. The percentage may change per battery and per platform. For example, the dock may only be powered when the battery is at 60 percent charge or higher, and when the battery drops below this level (without AC power) the dock loses power.
Attribute Name Description • Hdd1FanEnable network controller of the system, if present and enabled, or the first bootable network device found in the standard PCI search order of the system, whichever comes first. Disabled — If disabled, the boot override feature is disabled and the system boot sequence is in effect. Enables or disables the automatic fan controller, an error check of a fan. If a fan is detected, this function is automatically enabled.
Attribute Name Description IoModule Enables or disables I/O module. Possible values: • • KbdBacklightTimeoutAc Enabled Disabled Configures the time-out value for the keyboard backlight when an AC adapter is plugged into the system. Possible values: • • • • • • • • KbdBacklightTimeoutBatt 5s — Keyboard backlight stays on for 5 seconds. 10s — Keyboard backlight stays on for 10 seconds. 15s — Keyboard backlight stays on for 15 seconds. 30s — Keyboard backlight stays on for 30 seconds.
Attribute Name Description Possible values: [0-255]:[0-255]:[0-255] KeyboardBacklightEnabledColors Displays or enables the supported colors for the keyboard backlight in the rugged systems. 6 colors are available: 4 predefined colors (white, red, green, blue), and 2 user-configurable colors (custom1 and custom2). Multiple colors out of the 6 colors can be enabled at the same time. After enabling colors, you can switch among the enabled colors by pressing keys.
Attribute Name Description • LptMode Disabled - Disables the liquid cooler 2. Determines how the parallel port on the docking station operates. Possible values: • • • • M2PcieSsd0 Disabled — Port is disabled. At — Port is configured for IBM AT compatibility. Ps2 — Port is configured for IBM PS2 compatibility. Ecp — Extended Capability Port protocol. Enables or disables M2 PCIE SSD 0. Possible values: • • M2PcieSsd1 Enabled Disabled Enables or disables M2 PCIE SSD 1.
Attribute Name Description Possible values: • • Enabled — Allows the installation of the Microsoft Windows operating system on client systems with more than one operating system volume. Disabled — Prevents the installation of the Microsoft Windows operating system on client systems with more than one operating system volume.
Attribute Name Description Sata1 Enables or disables the second SATA drive controller. Possible values: • • Sata2 Enabled Disabled Enables or disables the third SATA drive controller. Possible values: • • Sata3 Enabled Disabled Enables or disables the fourth SATA drive controller. Possible values: • • Sata4 Enabled Disabled Enables or disables the fifth SATA drive controller. Possible values: • • Sata5 Enabled Disabled Enables or disables the sixth SATA drive controller.
Attribute Name Description • • • • • • Serial2 BMCLAN RAC RS232 RS422 RS485 Auto Configures the second (if available) built-in serial port. Possible values: • • • • • • • Serial3 Disabled COM2 COM4 RS232 RS422 RS485 Auto Configures the third (if available) built-in serial port. Possible values: • • • • • Serial4 Disabled RS232 RS422 RS485 Auto Configures the fourth (if available) built-in serial port.
Attribute Name Description Possible values: • • Touchscreen Enabled Disabled Enables or disables the touchscreen. Possible values: • • UefiNwStack Enabled Disabled This option is disabled by default. If enabled, UEFI Networking protocols are installed/ available, allowing pre-OS and early OS networking features to use the enabled NICs. This option may be used without turning on PXE.
Attribute Name Description Possible values: • • • • • • • • rtw — (Rest of the World) Sets the WLAN region code for the rest of the world. This option is selected by default. na — (North America (FCC)) Sets the WLAN region code for Canada and the United States. eur — (Europe) Sets the WLAN region code for Austria, Belgium, Czech Republic, Denmark, Finland, France, Germany, Ireland, Italy, Luxembourg, Netherlands, Norway, Poland, Portugal, Slovakia, Spain, Sweden, Switzerland, Turkey, and United Kingdom.
SystemLogs Table 23. SystemLogs Attribute Name Description BiosLogClear Prevents or allows the system event log to be cleared on the next boot. Possible values: • • PowerLogClear Keep — Does not clear the system event log on the next boot. Clear — Clears the system event log on the next boot. Prevents or allows the power event log to be cleared on the next boot. Possible values: • • ThermalLogClear Keep — Does not clear the power event log on the next boot.
Attribute Name Description TpmPpiDpo Controls the physical presence requirement for the following operations: Disable, Deactivate, and SetOwnerInstall_False. Possible values: • • TpmPpiPo Enabled Disabled Controls the physical presence requirement for the following operations: Enable, Activate, and SetOwnerInstall_True. Possible values: • • TpmSecurity Enabled — Physical presence is not required to perform any of these operations. Disabled — Physical presence is required to perform these operations.
Attribute Name Description Possible values: • • RearUSB3.0Ports Enabled Disabled Enables or disables the rear USB 3.0 ports. Possible values: • • ThunderboltBoot Enabled Disabled Enables or disables booting from the Thunderbolt device. Possible values: • • ThunderboltPorts Enabled Disabled Enables or disables the thunderbolt controller in the system. Possible values: • • ThunderboltPreboot Enabled Disabled Enables OROMs and pre-boot UEFI drivers provided by Thunderbolt devices or PCIe devices.
Attribute Name Description USBPort08 Enables or disables USB port 8. Possible values: • • USBPort09 Enabled Disabled Enables or disables USB port 9. Possible values: • • USBPort12 Enabled Disabled Enables or disables USB port 12. Possible values: • • USBPort13 Enabled Disabled Enables or disables USB port 13. Possible values: • • USBPort14 Enabled Disabled Enables or disables USB port 14. Possible values: • • USBPort15 Enabled Disabled Enables or disables USB port 15.
Attribute Name Description • USBPort19 Disabled Enables or disables USB port 19. Possible values: • • USBPort24 Enabled Disabled Enables or disables USB port 24. Possible values: • • USBPort25 Enabled Disabled Enables or disables USB port 25. Possible values: • • USBPort26 Enabled Disabled Enables or disables USB port 26. Possible values: • • USBPort27 Enabled Disabled Enables or disables USB port 27. Possible values: • • USBPort28 Enabled Disabled Enables or disables USB port 28.
Attribute Name Description UsbEmu If Boot Support is enabled, the system allows to boot any type of USB Mass Storage devices such as hard drive, memory key, floppy, etc. NOTE: USB-aware OS always see USB Mass Storage devices irrespective of this setting if the port is enabled. Possible values: • • • UsbPortsExternal Enabled Disabled EnabledWithNoUSBBoot Enables or disables the device attached to this USB port.
Attribute Name Description Possible values: • • UsbPortsRear Enabled Disabled Enables or disables all back USB Ports. Possible values: • • UsbPortsRear1 Enabled Disabled Enables or disables USB rear port 1. Possible values: • • UsbPortsRear2 Enabled Disabled Enables or disables USB rear port 2. Possible values: • • UsbPortsRear3 Enabled Disabled Enables or disables USB rear port 3. Possible values: • • UsbPortsRear4 Enabled Disabled Enables or disables USB rear port 4.
Attribute Name Description UsbPortsSide1 Enables or disables USB side port 1. Possible values: • • UsbPortsSide2 Enabled Disabled Enables or disables USB side port 2. Possible values: • • UsbRearDual Enabled Disabled Enables or disables the rear left dual USB ports. Possible values: • • UsbRearDual2Stack Enabled Disabled Enables or disables the rear right dual USB ports. Possible values: • • UsbRearQuad Enabled Disabled Enables or disables the rear quad USB ports.
Attribute Name Description Possible values: Integers ranging from 0 to 15 BrightnessBattery Sets the panel brightness in effect when the system is using battery power only. Possible values: Integers ranging from 0 to 15 DockDisplayPort1VideoSource Configures the source for the High-Definition Multimedia Interface (HDMI) and displays port 1 on the dock. Possible values: • • MultiDisplay Enabled — Uses the integrated video controller as video source.
Attribute Name Description NOTE: • • SwitchableGraphics This option has no effect if only one video device is present in the system. If the selected slot does not contain a video device, the system BIOS scans the slots and selects the primary video device. Enables or disables switchable graphics technologies such as NVIDIA, Optimus, and AMD PowerExpress. Possible values: • • Enabled Disabled VirtualizationSupport Table 27.
Attribute Name Description • LidMountedWirelessActivityLED Disabled This additional LED is mounted in the lid in a visible position. Possible values: • • Always Off — The LED always stays off irrespective of network activity. LED Indicates Wireless Activity Status — The LED becomes active whenever any of the wireless devices are capable of connecting to a wireless network.
Attribute Name Description WirelessSwitchWlanOnlyCtrl Determines that WLAN is controlled by the wireless On-Off switch. Possible values: • • WirelessWwan Enabled — Physical wireless On-Off switch can turn the WLAN On-Off. Disabled — Physical wireless On-Off switch will not be able to turn the WLAN On-Off. Enables or disables the internal wireless WAN device. Possible values: • • WirelessSwitchWlanCtrl Enabled Disabled Determines that WLAN and WiGig Radio is controlled by the wireless On-Off switch.
3 Error reporting in Dell Command | PowerShell Provider Dell Command | PowerShell Provider provides an Error Reporting feature. Dell Command | PowerShell Provider uses the PowerShell ErrorVariable parameter to capture the ErrorRecord. This ErrorVariable can be used to get more information such as exception, error id, error category, and recommended action etc. about an error. Example: To set the error variable. gi .\POSTBehavior\numl -ErrorVariable ev Example: To see more information about the error. $ev.
Error Category Error ID Scenarios Example NotValidNumber Doing set operation by giving noninteger value for an attribute accepts integer value. si .\PowerManagement\AutoOnHr “on” StringLengthNotInRange Doing set operation by giving string si .\SystemInformation\Asset which has out of range length for an “thisismorethan10characters” attribute which accepts a string having length within a range. InvalidTimeFormat Doing set operation by giving invalid time format.
Error Category Error ID Scenarios Example NotValidNumberForRGB Trying to provide invalid number for R, G or B components for KeyboardBacklightCustom1Color or KeyboardBacklightCustom2Color si .\SystemConfiguration \KeyboardBacklightCustom1Color “234:34:567” Attempt to set read-only attribute, si .\SystemInformation \ExpressServiceCode dsdasfjskfjskfskjd InvalidOperation SetItemForReadOnlyError si .\SystemInformation\SvcTag sdwadnakjsd ObjectNotFoun d NewDriveNotSupported If newly created drive n
4 Accessing documents from Dell support site You can access the required documents in one of the following ways: • Using the following links: – For all Enterprise Systems Management documents — Dell.com/SoftwareSecurityManuals – For OpenManage documents — Dell.com/OpenManageManuals – For Remote Enterprise Systems Management documents — Dell.com/esmmanuals – For iDRAC and Lifecycle Controller documents — Dell.com/idracmanuals – For OpenManage Connections Enterprise Systems Management documents — Dell.
