Dell Command | Powershell Provider Version 2.3 User's Guide
Total Page:16
File Type:pdf, Size:1020Kb
Dell Command | PowerShell Provider Version 2.3 User's Guide April 2020 Rev. A00 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. Other trademarks may be trademarks of their respective owners. Contents Chapter 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 Chapter 2: System requirements and prerequisites for Dell Command | PowerShell Provider 2.3............................................................................................................................................. 7 Supported Dell platforms................................................................................................................................................... 7 Prerequisites......................................................................................................................................................................... 7 Installing Windows PowerShell................................................................................................................................... 7 Configuring Windows PowerShell..............................................................................................................................8 Chapter 3: Download and installation steps for Dell Command | PowerShell Provider 2.3.............. 9 Downloading Dell Command | PowerShell Provider 2.3...................................................................................9 Downloading the Dell Command | PowerShell Provider 2.3 module from the Dell support site................ 9 Downloading and installing the Dell Command | PowerShell Provider 2.3 module from Microsoft Gallery...........................................................................................................................................................................9 Installing Dell Command | PowerShell Provider 2.3...................................................................................................10 Unblocking the DellCommandPowerShellProvider2.3_<build number>.zip...................................................10 Uninstalling Dell Command | PowerShell Provider 2.3..............................................................................................10 Upgrading Dell Command | PowerShell Provider 2.3.................................................................................................11 Chapter 4: Getting started with Dell Command | PowerShell Provider 2.3....................................12 Importing Dell Command | PowerShell Provider.........................................................................................................12 Navigating using the Windows PowerShell console.................................................................................................. 13 Supported cmdlets in Dell Command | PowerShell Provider...................................................................................13 Custom functions in Dell Command | PowerShell Provider.....................................................................................14 Parameters supported in Dell Command | PowerShell Provider............................................................................ 14 Configuring attributes using Dell Command | PowerShell Provider...................................................................... 15 Dell Command | PowerShell Provider drive........................................................................................................... 15 Format of the path...................................................................................................................................................... 16 Password parameters..................................................................................................................................................16 Features supported in Dell Command | PowerShell Provider................................................................................. 16 Using the AutoOn feature..........................................................................................................................................16 Using the AdvanceBatteryChargeConfiguration feature....................................................................................17 Using the PrimaryBattChargeCfg feature..................................................................................................... 18 Using the PeakShiftDayConfiguration feature......................................................................................................18 Using the Keyboard Backlight Color feature......................................................................................................... 19 Using the BootSequence feature............................................................................................................................ 20 Using the BIOS password feature........................................................................................................................... 22 Using the HardDisk Drive password feature.........................................................................................................23 Using TpmSecurity feature....................................................................................................................................... 24 Desired State Configuration (DSC) for Dell Command | PowerShell Provider..................................................24 Primary components of Desired State Configuration.........................................................................................25 Contents 3 Sample scripts..............................................................................................................................................................26 Chapter 5: Setting up Dell Command | PowerShell Provider 2.3 in Windows Preinstallation Environment.............................................................................................................................28 Chapter 6: Accessing help for Dell Command | PowerShell Provider 2.3...................................... 29 Accessing integrated help within Windows PowerShell console...........................................................................29 Chapter 7: Frequently asked questions for Dell Command | PowerShell Provider 2.3................... 30 Chapter 8: Troubleshooting scenarios for Dell Command | PowerShell Provider 2.3.................... 32 Chapter 9: Accessing documents from the Dell EMC support site................................................33 Chapter 10: Third-party licenses..................................................................................................34 4 Contents 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. Dell Command | PowerShell Provider works for local and remote systems, and even in Windows preinstallation environment. This module, with it is native configuration capability, makes BIOS configuration easily manageable. Topics: • Document scope and intended audience • Other documents you may need • What’s new in this release Document scope and intended audience This document describes the prerequisites, installation, and use of Dell Command | PowerShell Provider for Dell enterprise client systems. The supporting document is designed for IT professionals and system administrators are familiar with Windows PowerShell environment and want to simplify task automation and configuration management within a powerful scripting environment. Other documents you may need In addition to this guide, and the integrated help available within the module, you can access other available Dell Command | PowerShell Provider documents at dell.com/dellclientcommandsuitemanuals. To access other documents, 1. Go to dell.com/dellclientcommandsuitemanuals. 2. Click Dell Command | PowerShell Provider. 3. Click Dell Command | PowerShell Provider 2.3 link in the Product Support section. 4. Click the Manuals drop-down icon in the Product Support page. 5. To download the document, click the document’s PDF link. What’s new in this release ● Updated attribute names and possible values. To view the complete list of the new and the older names. 1. Go to Dell Knowledge Library and search for Dell Command | Configure page using