Dell Command | PowerShell Provider Version 2.
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. © 2008 - 2019 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 Introduction to Dell Command | PowerShell Provider 2.2............................................................................... 5 Document scope and intended audience........................................................................................................................ 5 Other documents you may need......................................................................................................................................5 What’s new in this release................
Sample scripts............................................................................................................................................................ 26 5 Setting up Dell Command | PowerShell Provider 2.2 in Windows Preinstallation Environment..................... 28 6 Accessing help for Dell Command | PowerShell Provider 2.2....................................................................... 29 Accessing integrated help within Windows PowerShell console..............................
1 Introduction to Dell Command | PowerShell Provider 2.2 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.
– In the Performance category: ◦ IntelSpdSelTech – In the PowerManagement category: ◦ PowerOnLidOpen ◦ PowerUsageMode – In the Intel Software Guard Extensions category: ◦ SgxLaunchControl – In the Manageability category: ◦ AmtCap – In the SystemConfiguration category: ◦ FingerprintReader ◦ FrontPowerButton ◦ FingerprintReaderSingleSignOn ◦ IgnitionSwitchEnable ◦ IgnitionSwitchOnDelay ◦ IgnitionSwitchOffDelay ◦ IgnitionSwitchDebounceCycle ◦ IoModule 2 ◦ IoModule 3 ◦ IoModule 4 ◦
2 System requirements and prerequisites for Dell Command | PowerShell Provider 2.2 This chapter describes the supported software and prerequisites for using Dell Command | PowerShell Provider. Topics: • Supported Dell platforms • Prerequisites Supported Dell platforms For information on supported Dell platforms see Dell Command | PowerShell Provider Release Notes available at dell.com/ dellclientcommandsuitemanuals.
Configuring Windows PowerShell • Ensure that you have Administrative privileges on the Dell business client system. • By default Windows PowerShell has its ExecutionPolicy set to Restricted. To run the Dell Command | PowerShell Provider cmdlets and functions, ExecutionPolicy must be changed to RemoteSigned at a minimum.
3 Download and installation steps for Dell Command | PowerShell Provider 2.2 This chapter describes how to download, install, uninstall, and upgrade Dell Command | PowerShell Provider. Topics: • Downloading Dell Command | PowerShell Provider 2.2 • Installing Dell Command | PowerShell Provider 2.2 • Uninstalling Dell Command | PowerShell Provider 2.2 • Upgrading Dell Command | PowerShell Provider 2.2 Downloading Dell Command | PowerShell Provider 2.
• PowerShell get package manager nuget-anycpu.exe. 1 Open Windows PowerShell with administrator privileges. 2 To find the Dell Command | PowerShell Provider module, run the following command: Find-Module DellBIOSProvider. 3 To install the module, run the following command based on the OS: • For 32 bit operating system, Install-Module DellBIOSProviderX86. • For 64 bit operating system, Install-Module DellBIOSProvider.
Upgrading Dell Command | PowerShell Provider 2.2 If you have Dell Command | PowerShell Provider already installed in your system, then remove the Dell Command | PowerShell Provider folders and files before installing the later version of Dell Command | PowerShell Provider.
4 Getting started with Dell Command | PowerShell Provider 2.2 This chapter describes importing the module, general navigation, supported cmdlets, and custom functions of Dell Command | PowerShell Provider.
To verify the import, run the following cmdlet within PowerShell console, and look for DellSMBIOS. Get-PSDrive NOTE: To remove Dell Command | PowerShell Provider from the console, run the following command within the Windows PowerShell console: For 32-bit systems; Remove-Module DellBiosProviderX86 –Verbose For 64-bit systems; Remove-Module DellBIOSProvider –Verbose Navigating using the Windows PowerShell console After importing the module, navigate to DellSMBIOS drive.
Cmdlet Alias Description Get-ChildItem dir Displays the child items at the specified location within the DellSMBIOS drive. Set-Item si Sets the value of the item. Find-Module fimo Finds available modules from the online PowerShell Gallery. Get-Module gmo Gets the list modules that have been imported or that can be imported into the current session. Install-Module inmo Installs the specified module from the PowerShell Gallery.
Parameters Description Applicable For Endtime Specifies the time when the system stops consuming battery power and starts consuming AC power, if available. PeakShiftDayConfiguration ChargeStartTime Specifies the time when the system starts charging battery while consuming AC power, if available. PeakShiftDayConfiguration BeginingOfDay Configures the AdvanceBatteryCharge start time in 24 AdvanceBatteryChargeConfiguration hours format. WorkPeriod Configures the duration of charging.
NOTE: A path can be a path to a category or a path to an attribute. Password parameters Dell Command | PowerShell Provider allows you to provide a password either in plain text or in secure text. -Password: Provide the password that is set in the plain text. Format: Set-Item –Path -Password Example: Set-Item –Path DellSMBIOS:\POSTBehavior\Numlock "Enabled" -Password -PasswordSecure: Provide the password that is set in a secure text.
• AutoOnMn — To set the minute at which you want the system to turn on automatically, provide the value ranging from 0-59. To set the time 11:59 p.m., provide the value as 59. Example: To turn on the system automatically on weekdays. Command: Set-Item -Path DellSmbios:\PowerManagement\AutoOn "Weekdays" Example: To turn on the system automatically on Fridays. Command: Set-Item -Path DellSmbios:\PowerManagement\AutoOnFri "Enabled" Example: To turn on the system automatically on Sundays at 11:59 p.m..
• Adaptive — Charges the battery in Express Charge mode using the express charging algorithm, Dell's fast charging technology. • PrimACUse — Charges the battery while plugged-in, preferred for the users who operate their system while plugged in to an external power source. • Custom — The battery charging starts and stops based on the settings specified in Primary Battery Custom Charge Start and Primary Battery Custom Charge End.
NOTE: Peak Shift Start Time must be less than or equal to Peak Shift End Time, and Peak Shift End Time must be less than or equal to Peak Shift Charge Start Time. Example: To retrieve the PeakShiftDayConfiguration current settings. The StartTime, EndTime, and ChargeStartTime are displayed for all days. Get-Item -Path DellSmbios:\PowerManagement\PeakShiftDayConfiguration Example: To set the PeakShift StartTime, EndTime, and ChargeStartTime for Sunday. Set-Item -Path DellSmbios:\PowerManagement\PeakShiftDayCo
KeyboardBacklightCustom1Color Configures the custom1color by specifying the Red, Green, and Blue (R:G:B) values. The color can be selected using RGB components by mentioning it in ‘R:G:B’ format. Each color component value ranges from 0 to 255. Example: Retrieves the RGB value in R:G:B format of Custom1 color for keyboard backlight. Get-ChildItem -Path DellSmbios:\SystemConfiguration\KeyboardBacklightCustom1Color KeyboardBacklightCustom2Color Configures the custom2color by specifying the Red, Green, and Bl
– wifi — Wi-Fi device – emmc — eMMC device • Legacy (the default) — To ensure compatibility with operating systems that do not support UEFI.
Using the BIOS password feature This feature allows you to set, change, or clear Admin password and System password. Verifying the status of Admin or System passwords To verify the status whether the Admin or System passwords are set on the system, use the following attributes: • IsAdminPasswordSet — Displays if admin password is set on the system. • IsSystemPasswordSet — Displays if system password is set on the system.
• If the Admin password is set in the system, and you want to configure BIOS tokens/features, you need to provide the Admin password. • If the Admin and system passwords are set in the system, and you want to configure BIOS tokens/features, you need to provide the Admin password. • If the Admin and system passwords are set in the system, and if you want to configure BIOS tokens/features as well as change system password, you need to provide either the System or the Admin password.
Example: To clear the HDD password. Set-Item -Path DellSmbios:\Security\HDDPassword "" -PasswordSecure NOTE: Restart the system to apply the changes. Using TpmSecurity feature This feature allows you to control whether the Trusted Platform Module (TPM) in the system is enabled and visible to the operating system. The TpmSecurity setting is a master switch for all the rest of the TPM fields. System restart is required after changing the TpmSecurity setting.
NOTE: To initiate remote command, check system and configuration requirements in details by executing the following cmdlet: get-help about_Remote_Requirements Primary components of Desired State Configuration Desired State Configuration is a declarative framework used for configuration, deployment, and management of systems. It consists of three primary components: • Configuration—Configuration defines the type of function that is used in DSC through declarative scripts.
Sample scripts This section provides some exemplary sample scripts that depict the typical usage of Desired State Configuration using the functionality of Dell Command | PowerShell Provider for enforcing BIOS settings of the supported attributes. The scripts authored for Desired State Configuration should be saved in .ps1 format. NOTE: • Category property is mandatory field for each resource. • BlockDefinition is a mandatory property only for the Powermanagement category.
Configuring PeakShiftDayConfiguration in category Powermanagement Configuration PowerManagementConfigurationPeak { Import-DscResource -ModuleName DellBIOSProvider Node localhost { PowerManagement PowerManagementSettingsSaturday { Category = "PowerManagement" BlockDefinition="1" PeakShiftDayConfiguration = "Saturday" StartTime = "10:30" EndTime = "12:30" ChargeStartTime = "13:30" } } } PowerManagement PowerManagementSettingsWednesday { Category = "PowerManagement" BlockDefinition="2" PeakShiftDayConfigura
5 Setting up Dell Command | PowerShell Provider 2.2 in Windows Preinstallation Environment Windows Preinstallation Environment (WinPE) provides a stand-alone preinstallation environment that is used to prepare a system for Windows installation. For client systems that do not have an operating system that is installed, you can create a bootable image that contains Dell Command | PowerShell Provider to run the commands on WinPE.
6 Accessing help for Dell Command | PowerShell Provider 2.2 Dell Command | PowerShell offers cmdlet-based integrated help. This section describes various cmdlets that you can use to access various help topics. Accessing integrated help within Windows PowerShell console Dell Command | PowerShell Provider provides integrated help for its custom features.
7 Frequently asked questions for Dell Command | PowerShell Provider 2.2 What is PowerShell Gallery? PowerShell Gallery is a public repository that is hosted by Microsoft. You can download and install Dell Command | PowerShell Provider from here. See Downloading Dell Command | PowerShell Provider module from Microsoft Gallery.
What can I do using Dell Command | PowerShell Provider? You can configure the BIOS settings of your system using Dell Command | PowerShell Provider. See Introduction. Can I use Dell Command | PowerShell Provider in nonWindows Dell client systems? No, Dell Command | PowerShell Provider can be used only on systems running Windows PowerShell console, and therefore cannot be used on a non-Windows Dell client system.
8 Troubleshooting scenarios for Dell Command | PowerShell Provider 2.2 DellBIOSProvider cannot be loaded because running script is disabled on this system. By default Windows PowerShell has its ExecutionPolicy set to Restricted. To run the Dell Command | PowerShell Provider cmdlets and functions, PowerShell execution policy must be changed to RemoteSigned at a minimum.
9 Accessing documents from the Dell EMC support site You can access the required documents using the following links: • For Dell EMC Enterprise Systems Management documents — www.dell.com/esmmanuals • For Dell EMC OpenManage documents — www.dell.com/openmanagemanuals • For Dell EMC Remote Enterprise Systems Management documents — www.dell.com/esmmanuals • For iDRAC and Dell Lifecycle Controller documents — www.dell.
10 Third-party licenses The table provides the details about third-party licenses. Table 6. Third-party licenses Component name Version License type libxml2 2.9.4 MIT Open Software License 0.12.3 OSL License PCI.IDS 2019.03.05 3-clause BSD License Generic disclaimer >> Powershell PSReadline module saves every console command you enter to a text file. So, its strongly recommended to use "GetCredential" comandlet to handle password securely.
1) Grant of Copyright License.
9) Acceptance and Termination. If You distribute copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License.
PARTICULAR PURPOSE ARE DISCLAIMED.
