Users Guide
Table Of Contents
- Dell OpenManage Essentials Version 2.2 User's Guide
- About OpenManage Essentials
- Installing OpenManage Essentials
- Installation Prerequisites and Minimum Requirements
- Terms and Conditions for Using Relational Database Management Systems
- Minimum Login Roles for Microsoft SQL Server
- Database Size and Scalability
- Downloading OpenManage Essentials
- Installing OpenManage Essentials
- Setting Up OpenManage Essentials Database on a Remote SQL Server
- Retargeting the OpenManage Essentials Database
- Installing OpenManage Essentials on a Domain Controller
- Installing OpenManage Essentials on a Domain Controller With a Remote Database
- Installing OpenManage Essentials on a Domain Controller With a Local Database
- Adding Users to the OpenManage Essentials User Groups
- Enabling SQL Server and Windows Authentication Mode in SQL Server
- Verifying SQL Server TCP/IP Status
- Installing Dell SupportAssist
- Installing Repository Manager
- Installing Dell License Manager
- Setting Up and Configuring VMware ESXi 5
- Upgrading OpenManage Essentials
- Uninstalling OpenManage Essentials
- Migrating IT Assistant to OpenManage Essentials
- Getting Started With OpenManage Essentials
- Launching OpenManage Essentials
- Configuring OpenManage Essentials
- Discovery Wizard Configuration
- Configuring Discovery Settings
- Using the OpenManage Essentials Home Portal
- OpenManage Essentials Heading Banner
- Customizing Portals
- Displaying Additional Available Reports and Graphs
- Saving and Loading the Portal Layout
- Updating the Portal Data
- Hiding Graphs and Reports Components
- Rearranging or Resizing Graphs and Reports (Components)
- Filtering Data
- Search Bar
- Map View (Home) Portal
- Viewing the User Information
- Logging On As a Different User
- Using the Update Available Notification Icon
- Using the Warranty Scoreboard Notification Icon
- OpenManage Essentials Home Portal — Reference
- Discovering and Inventorying Devices
- Supported Devices, Protocols, and Features Matrix
- Supported Operating Systems (Servers), Protocols, and Features Matrix
- Supported Storage Devices, Protocols, and Features Matrix
- Legend and Definitions
- Using the Discovery and Inventory Portal
- Protocol Support Matrix for Discovery
- Protocol Support Matrix for System Update
- Devices Not Reporting Service Tag
- Creating a Discovery and Inventory Task
- Discovering a Chassis and its Components Using the Guided Wizard
- Excluding Ranges
- Viewing Configured Discovery and Inventory Ranges
- Scheduling Discovery
- Scheduling Inventory
- Configuring Status Polling Frequency
- Task Pop-Up Notifications
- Discovery And Inventory — Reference
- Discovery and Inventory Portal Page Options
- Discovery and Inventory Portal
- Viewing Device Summary
- Add Discovery Range
- Discovery Configuration
- Device Type Filtering
- ICMP Configuration
- SNMP Configuration
- WMI Configuration
- Storage Configuration
- WS-Man Configuration
- SSH Configuration
- IPMI Configuration
- Discovery Range Action
- Summary
- Add Exclude Range
- Discovery Schedule
- Inventory Schedule
- Status Schedule
- Discovery Ranges
- Exclude Ranges
- Managing Devices
- Viewing Devices
- Viewing Device Inventory
- Viewing Alerts Summary
- Viewing System Event Logs
- Searching for Devices
- Creating a New Group
- Adding Devices to a New Group
- Adding Devices to an Existing Group
- Hiding a Group
- Deleting a Group
- Single Sign-On
- Creating a Custom URL
- Configuring Warranty Email Notifications
- Configuring Warranty Scoreboard Notifications
- Configuring Warranty Pop-Up Notifications
- Using Map View
- Map Providers
- Configuring Map Settings
- General Navigation and Zooming
- Home View
- Tool Tip
- Selecting a Device on Map View
- Health and Connection Status
- Multiple Devices at the Same Location
- Setting a Home View
- Viewing All Map Locations
- Adding a Device to the Map
- Moving a Device Location Using the Edit Location Details Option
- Importing Licensed Devices
- Using the Map View Search Bar
- Removing All Map Locations
- Editing a Map Location
- Removing a Map Location
- Exporting All Device Locations
- Dell PowerEdge FX Chassis View
- Support For PowerEdge FX Chassis Sleds
- VLAN Configuration Management
- Dell NAS Appliance Support
- OEM Device Support
- Devices — Reference
- Deployment and Re-provisioning
- OpenManage Essentials — Server Configuration Management License
- Device Requirements for Deployment and Compliance Tasks
- Getting Started for Device Configuration Deployment
- Overview of Bare Metal Deployment
- Viewing the Deployment Portal
- Configuring the Deployment File Share
- Creating a Device Configuration Template
- Adding Devices to the Repurpose and Bare Metal Devices Group
- Managing Device Configuration Templates
- Deploying a Device Configuration Template (Bare Metal Deployment)
- Deploying IOA Configuration Template
- Deploying a Network ISO Image
- Removing Devices From the Repurpose and Bare Metal Devices Group
- Auto Deploying Device Configurations
- Importing Device Specific Attributes
- Import File Requirements
- Exporting Device Specific Attributes
- Viewing the Deployment Tasks
- Managing the Virtual I/O Identities of a Server (Stateless Deployment)
- Overview of Stateless Deployment
- Virtual I/O Pools
- Compute Pools
- Creating a Compute Pool
- Deploying a Device Configuration Template (Stateless Deployment)
- Automatic Locking of a Compute Pool
- Unlocking a Compute Pool
- Editing the Definitions of a Compute Pool
- Viewing the Definitions of a Compute Pool
- Removing a Server From a Compute Pool
- Renaming a Compute Pool
- Deleting a Compute Pool
- Replacing a Server
- Reclaiming Deployed Virtual I/O Identities of a Server
- Reclaiming Assigned Virtual I/O Identities
- Setting Up Device Configuration Auto Deployment (Stateless Deployment)
- Viewing the Profile (Last Deployed Attributes)
- Known Limitations for Stateless Deployment
- Additional Information
- Deployment – Reference
- Icons and Descriptions
- Repurpose and Bare Metal Devices
- Auto Deployment
- Tasks
- Task Execution History
- Device Configuration Template Details
- IOA VLAN Attributes
- Device Configuration Setup Wizard
- Create Template Wizard
- Create Virtual I/O Pool Wizard
- Virtual I/O Pools
- Virtual I/O Pool Summary
- Create Compute Pool Wizard
- Compute Pool Summary
- Compute Pool Details
- Server Details
- Deploy Template Wizard
- Setup Auto Deployment Wizard
- Manage Auto Deployment Credentials
- Replace Server Wizard
- Reclaim Identities Wizard
- Managing Server Configuration Baseline
- Viewing the Device Compliance Portal
- Getting Started for Device Configuration Compliance
- Device Configuration Compliance Overview
- Configuring the Credentials and Device Configuration Inventory Schedule
- Associating Target Devices to a Configuration Template
- Viewing the Device Configuration Inventory
- Viewing the Device Compliance Status
- Viewing the Compliance Tasks
- Configuration – Reference
- Viewing Inventory Reports
- Reports — Reference
- Server Inventory Reports
- Agent and Alert Summary
- Agent Health Status
- Server Overview
- Field Replaceable Unit (FRU) Information
- Hard Drive Information
- iDRAC Performance Minimum/Maximum
- iDRAC Performance Average/Peak
- Memory Information
- Modular Enclosure Information
- NIC Information
- PCI Device Information
- Processor Information
- Storage Controller Information
- Virtual Disk Information
- Server Configuration Reports
- Warranty & License Reports
- Virtualization Reports
- Asset Reports
- Server Inventory Reports
- Viewing Warranty Reports
- Managing Alerts
- Alerts — Reference
- Updating Server BIOS, Firmware, Drivers, and Applications
- Viewing the System Update Page
- Understanding Server BIOS Firmware and Drivers Sources
- Choosing the Right Source for Updates
- Selecting an Update Catalog Source
- Viewing Comparison Results
- System Update Use Case Scenarios
- Applying System Updates Using the Non-Compliant Systems Tab
- Applying System Updates Using the System Update Task Wizard
- Updating Firmware, BIOS, and Drivers Without OMSA
- View Active Catalog
- Issues and Resolutions Use Case Scenarios
- Configuring the Settings for Automatic Purging of Downloaded Files
- System Update — Reference
- Managing Remote Tasks
- Remote Tasks — Reference
- Managing Security Settings
- Troubleshooting
- OpenManage Essentials Troubleshooting Tool
- Troubleshooting Procedures
- Troubleshooting Inventory
- Troubleshooting Device Discovery
- Troubleshooting Receiving SNMP Traps
- Troubleshooting Discovery of Windows Server 2008–Based Servers
- Troubleshooting SNMP Traps for ESX or ESXi Versions 3.5, 4.x, or 5.0
- Troubleshooting Problems With Microsoft Internet Explorer
- Troubleshooting Map View
- Frequently Asked Questions
- Managing Device Group Permissions
- OpenManage Mobile Settings
- Settings — Reference
- Logs — Reference
- Dell Solutions
- Right-Click Actions
- Tutorials
- Using OpenManage Essentials Command Line Interface
- Launching the OpenManage Essentials Command Line Interface
- Creating a Discovery Profile Input File
- Specifying IPs, Ranges, or Host names Using XML or CSV Files
- Specifying Input Files in PowerShell
- Command Line Interface Commands
- Creating a Discovery Range
- Removing a Discovery Range
- Creating a Discovery Range Group
- Removing a Discovery Range Group
- Editing a Discovery Range
- Editing a Discovery Range Group
- Enabling a Discovery Range or Discovery Range Group
- Disabling a Discovery Range or Discovery Range Group
- Creating a Discovery Exclude Range
- Removing a Discovery Exclude Range
- Running Discovery, Inventory, and Status Polling Tasks
- Removing a Device
- Retrieving the Status Execution Progress of a Discovery Range
- Stopping a Running Discovery Range or Group
- Creating a Custom Device Group
- Adding Devices to a Custom Group
- Deleting a Group

To manage Generic command line tasks:
1. From OpenManage Essentials, click Manage → Remote Tasks → Common Tasks → Create Command Line Task.
2. In the General tab, choose Generic Command.
3. If required, update the task name.
4. Enter the path and command (batch, script, or executable) to run on the local system.
5. (Optional) Enter any arguments for the command. If $USERNAME and $PASSWORD are used in Arguments, you can pass the
credentials to the command by the entering the credentials under Script Credentials. If $IP or $RAC_IP are used in
Arguments, you can run the command against the selected target(s) by passing the IP address of each target to the
command.
NOTE: The tokens provided in the Arguments field must entirely be in either uppercase or lowercase. For example,
$HOSTNAME or $hostname.
NOTE: If you are running a command that does not require any tokens or arguments, the Script Credentials section
and the Task Target tab are not displayed.
6. (Optional) Choose Ping Device if you want to ping the device first.
7. (Optional) Choose Output to file to capture task output from multiple targets. Enter path and file name.
• To log the information from all selected targets, select Append.
• To write all the detected errors to the log file, select Include errors.
8. On Task Target, do one of the following:
• Select a query from the drop-down list or create a new query by clicking the New button.
• Select targets for running the commands.
9. On Schedule and Credentials, enter the local administrator credentials with rights to run commands on the OpenManage
Essentials system. Set schedule for the task(s) and then click Finish.
Related links
About Tokens
Generic Command
About Tokens
The following tokens can be used to pass values to the batch, script, or executable file:
• $IP and $RAC_IP — If these arguments are used, the Task Target tab appears in the Create a Command Link Task screen.
The Task Target tab allows you to select the targets to pass the arguments. $IP is used for a server IP and $RAC_IP is used for
a RAC (iDRAC) IP. From the Task Target tab, you can select either groups, a device or use dynamic queries.
• $USERNAME and $PASSWORD — In some instances, you must provide credentials for a remote system in your batch or
script file. If $USERNAME or $PASSWORD are used in arguments, the Script Credentials section appears for these values. The
credentials entered in the Script Credentials section is passed to the command line. You can pass either of these values or
both.
NOTE: You must enter both values in the Script Credentials section. If you do not need to use one value, enter any
text in the field and it is ignored if the token is not in use.
• $NAME — This token passes the name of the system found in the OpenManage Essentials Device Tree. The name is most
often the host name of the system, but in some instances it might be either an IP address or a string such as Dell Rack
System – SVCTAG1
.
Passing Tokens to a Script
If you are using a batch file or a script, use %1, %2, %3 , and so on to receive the values passed from OpenManage Essentials. The
values are passed in the order they are entered from left to right in the Arguments field.
For example, if you use $USERNAME $PASSWORD $IP $RAC_IP $NAME as arguments, a batch file with the following Echo %1
%2 %3 %4 %5 displays the following result:
C:\Windows\system32>echo scriptuser scriptpw 10.36.1.180 10.35.155.111 M60505-W2K8x64
scriptuser scriptpw 10.36.1.180 10.35.155.111 M60505-W2K8x64
292