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. © 2020 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.3................................................................. 5 Document scope and intended audience........................................................................................................................... 5 Other documents you may need......................................................................................................................................... 5 What’s new in this release.......................
5 Setting up Dell Command | PowerShell Provider 2.3 in Windows Preinstallation Environment...........28 6 Accessing help for Dell Command | PowerShell Provider 2.3.......................................................... 29 Accessing integrated help within Windows PowerShell console.................................................................................. 29 7 Frequently asked questions for Dell Command | PowerShell Provider 2.3........................................
1 Introduction to Dell Command | PowerShell Provider 2.3 Dell Command | PowerShell Provider is a module that makes BIOS configuration easily manageable through the Windows PowerShell interface. It works for local and remote systems, and in a Windows Preinstallation Environment (WinPE). This document describes the supported attributes, and error reporting in Dell Command | PowerShell Provider.
• 6 • • M2PcieSsd3 • TabletButtonsTimeoutAc • TabletButtonsTimeoutBatt • SignOfLifeByLogo In the PostBehaviour category: • • DockWarningsEnMsg In the Wireless category: • • DynamicWirelessTransmitPower • AntennaSwitch In the USBConfiguration category: • • UsbGpsCoexistence In the PreEnabled category: • • TelemetryAccessLvl In the Passwords category: • PwdMinLen • PwdLowerCaseRqd • PwdUpperCaseRqd • PwdDigitRqd • PwdSpecialCharRqd There are certain preenabled features in Dell Command | PowerShell
2 System requirements and prerequisites for Dell Command | PowerShell Provider 2.3 This section 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.
• 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. To apply the ExecutionPolicy, run Windows PowerShell with Administrator privileges, and run the following command within the PowerShell console: Set-ExecutionPolicy RemoteSigned -force NOTE: • If there are more restrictive security requirements, set the ExecutionPolicy to AllSigned.
3 Download and installation steps for Dell Command | PowerShell Provider 2.3 This section describes how to download, install, uninstall, and upgrade Dell Command | PowerShell Provider. Topics: • • • • Downloading Dell Command | PowerShell Provider 2.3 Installing Dell Command | PowerShell Provider 2.3 Uninstalling Dell Command | PowerShell Provider 2.3 Upgrading Dell Command | PowerShell Provider 2.3 Downloading Dell Command | PowerShell Provider 2.
• • For 32-bit operating system, Install-Module DellBIOSProviderX86. For 64-bit operating system, Install-Module DellBIOSProvider. The latest version of Dell Command | PowerShell Provider available at Microsoft Gallery is installed. 4. To download the nuget-anycpu.exe file, enter Y. Installing Dell Command | PowerShell Provider 2.
Upgrading Dell Command | PowerShell Provider 2.3 If you have Dell Command | PowerShell Provider that are 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.3 This section describes on how to import the module, general navigation, supported cmdlets, and custom functions of Dell Command | PowerShell Provider.
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. Run Get-ChildItem cmdlet to view the list of available categories. Figure 2. Accessing categories and attributes To access the attributes in each category, set location to the desired category and then run Get-Childitem cmdlet.
Cmdlet Alias Description 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. Import-Module ipmo Adds or imports the module to the current session. Remove-Module rmo Removes the imported module from the PowerShell console. Remove-PSDrive rdr Removes the Windows PowerShell drive.
Parameters Description Applicable For WorkPeriod Configures the duration of charging. AdvanceBatteryChargeConfiguration AdminPassword Specifies that admin password must be provided while setting HDD password if administrator has restricted the changes to HDD password. HDDPassword ATAMaximumSecurity Mode Specifies the ATA Maximum Security Mode.
Example: Set-Item –Path DellSMBIOS:\POSTBehavior\Numlock "Enabled" -Password -PasswordSecure: Provide the password that is set in a secure text. Format: Set-Item –Path -PasswordSecure Example: Set-Item –Path DellSMBIOS:\POSTBehavior\Numlock "Enabled" -PasswordSecure Features supported in Dell Command | PowerShell Provider This section describes the usage of various attributes/features in Dell Command | PowerShe
Example: To turn on the system automatically on Sundays at 11:59 p.m.. Command: Set-Item -Path DellSmbios:\PowerManagement\AutoOnSun "Enabled" Set-Item -Path DellSmbios:\PowerManagement\AutoOnHr "23" Set-Item -Path DellSmbios:\PowerManagement\AutoOnMn "59" Using the AdvanceBatteryChargeConfiguration feature This feature allows you to configure AdvBatteryChargeCfg and AdvancedBatteryChargeConfiguration options in the PowerManagement category.
Example: To retrieve the current mode of the PrimaryBattChargeCfg attribute. Get-ChildItem -Path DellSmbios:\PowerManagement\PrimaryBattChargeCfg If the status retrieved as Custom, then to know the percent when charging starts and ends, retrieve CustomChargeStart and CustomChargeStop attributes. Example: To set the battery charging mode as standard. Set-Item -Path DellSmbios:\PowerManagement\PrimaryBattChargeCfg "Standard" Example: To set the battery charge mode as custom and then to specify the start time
Example: To change StartTime value for Monday. EndTime and ChargeStartTime values remain unchanged for Monday. Set-Item -Path DellSmbios:\PowerManagement\PeakShiftDayConfiguration Monday -StartTime "09:00" Using the Keyboard Backlight Color feature This feature allows you to configure the supported colors for the keyboard backlight on rugged systems. There are six available colors: four predefined colors (white, red, green, blue), and two user configurable colors (custom1 and custom2).
Example: To set the red as 234, green as 35 and blue as 56 for Custom1 color using KeyboardBacklightCustom1Color attribute. Provide the secure password, if set, using the secure password parameter. Set-Item -Path DellSmbios:\SystemConfiguration\KeyboardBacklightCustom2Color "234:35:56" – PasswordSecure Provide the secure password, if set, using the secure password parameter.
BootSequence — Specifies the order in which a system searches for devices when trying to find an operating system to boot. The Boot Sequence option allows users to customize the boot order and boot ability of boot devices. The UEFI BIOS allows the selection of UEFI boot paths or Legacy boot devices. To configure the sequence of the boot devices, verify the current status of the boot order with name, shortform, and device number. Then, provide the sequence to change the boot order.
Changing Admin or System passwords To change the existing password, run the command in the following format: Example: To change the Admin password: Set-Item -Path DellSmbios:\Security\AdminPassword -Password Example: To change the System password: Set-Item -Path DellSmbios:\Security\SystemPassword -Password NOTE: If both Admin and System passwords exist, then to change the system password, provide either Admin or
• ATAMaximumSecurityMode — Provide the value as '0' if you want HDD to be configured in ATA High Security Mode, or '1' if you want the HDD to be configured in ATA maximum Security Mode (Secure Erase). Setting the HDD password To set the password, run the command in the following format: Example: To set the HDD password in maximum security mode. Set-Item -Path DellSmbios:\Security\HDDPassword -ATAMaximumSecurityMode "1" Changing the HDD password To change the existing password, run the comm
Example: To enable TPM Activation. TPM Activation can be enabled only if the Tpmsecurity is enabled. Set-Item -Path DellSmbios:\TpmSecurity\TPMActivation "Enabled" -Password NOTE: Admin password must be provided and TpmSecurity should have been enabled to enable the TpmActivation.
Dell Command | PowerShell Provider resources work seamlessly in both Push and Pull modes. In Push mode you author a configuration, stage it to generate the Managed Object Format (MOF), and enact it on target nodes. In Push mode the server is only a medium to author and enact the configuration onto nodes. The Local Configuration Manager (LCM) agent on the target nodes, ensures that systems are configured according to the configuration declaration. In Pull mode, the server is defined as a Pull Server.
{ } } } Category = "PowerManagement" BlockDefinition="1" AdvancedBatteryChargeConfiguration = "Tuesday" BeginningOfDay = "10:30" WorkPeriod = "15:45" PowerManagement PowerManagementSettingsSunday { Category = "PowerManagement" BlockDefinition="2" AdvancedBatteryChargeConfiguration = "Sunday" BeginningOfDay = "13:30" WorkPeriod = "15:45" } #resource name Configuring PeakShiftDayConfiguration in category Powermanagement Configuration PowerManagementConfigurationPeak { Import-DscResource -ModuleName Del
} } NOTE: For more sample scripts, see theDellBIOSProvider > DSC_SampleScripts folder. Getting started with Dell Command | PowerShell Provider 2.
5 Setting up Dell Command | PowerShell Provider 2.3 in Windows Preinstallation Environment Windows Preinstallation Environment (WinPE) provides a stand-alone 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. 1. From the Microsoft website, download and install Windows ADK on the client system.
6 Accessing help for Dell Command | PowerShell Provider 2.3 Dell Command | PowerShell offers cmdlet-based integrated help. This section describes various cmdlets that you can use to access various help topics. Topics: • Accessing integrated help within Windows PowerShell console 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.3 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.
How can I get possible values for a particular attribute? To get the possible values for a particular attribute, run the following command: Get-Item -Path | Select PossibleValues 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.
8 Troubleshooting scenarios for Dell Command | PowerShell Provider 2.3 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 by selecting your product. 1. Go to www.dell.com/manuals. 2. Click Browse all products, click Software, and then click Client Systems Management. 3. To view the documents, click the required product name and version number.
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.
* to distribute copies of the Original Work and Derivative Works to the public, with the proviso that copies of Original Work or Derivative Works that You distribute shall be licensed under the Open Software License; * to perform the Original Work publicly; and * to display the Original Work publicly. 2) Grant of Patent License.
penalties of the U.S. Copyright Act, 17 U.S.C. § 101 et seq., the equivalent laws of other countries, and international treaty. This section shall survive the termination of this License. 12) Attorneys Fees.
