Dell Lifecycle Controller Remote Services Version 1.
Notes and Cautions NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION indicates potential damage to hardware or loss of data if instructions are not followed. ____________________ Information in this document is subject to change without notice. © 2011 Dell Inc. All rights reserved. Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden.
Contents 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . Why Use Remote Services? . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 What’s New in Remote Services . . . . . . . . . . . . 15 . . . . . . . . . . . . . 16 . . . . . . . . . . . . 20 . . . . . . . . . . . . . . 21 Other Documents You May Need Using Remote Services Prerequisites for Using Remote Services . . . . . . . . 21 . . . . . . . . . . . . . . . . 21 . . . . . . . . . . . . . . . . . . .
Auto-Discovery Configuration . . . . . . . . . . . Connecting to Provisioning Server for Initial Credential Deployment . . . . . . . . . . . . Remotely Reinitiating Auto-Discovery in New Environments . . . . . . . . . . . . . . . . . . Managing Certificates . 30 . . . . . . . . . . . . . . . . . 31 . . . . . . . . . . . . . Deploying the Operating System . . . . . . . . . . . . . 31 33 Operating System Deployment Features . . . . . . 33 Remote Operating System Deployment Interface . . .
Lifecycle Log . . . . . . . . . . . . . . . . . . . . . . . Exporting Lifecycle Log . . . . . . . . . . . . . . . Deleting Configuration and Resetting to Defaults . . . . . . . . . . . . . . . . . . Managing NICs/CNAs 51 52 . . . . . 52 . . . . . . . . . . . . . . . . . . 52 Displaying the NIC/CNA Inventory . . . . . . . . . 53 Displaying the NIC/CNA Attributes . . . . . . . . . 53 . . . . . . . . . . 53 . . . . . . . . . . . .
4 Remote Services Profiles . . . . . . . . . . . Operating System Deployment Profile . . . . . . . . . . Operating System Deployment Methods . 63 . . . . . . . 64 . . . . . . . . . . . . . . . . 65 Auto-Discovery Methods . . . . . . . . . . . . . . Export and Import Methods . Lifecycle Log Methods . . . . . . . . . . . . 65 66 . . . . . . . . . . . 66 . . . . . . . . . . . . . . . . . . . . 66 Simple NIC Methods . . . . . . . . . . . . . . . . BIOS and Boot Management Profile . . . .
Feature or System Behavior Workflow . . . . . . . . . . . . 79 . . . . . . . . . . . . . . . . . . . . . . 80 References . . . . . . . . . . . . . . . . . . . . . Importing Server Profile from a iDRAC vFlash Card or a Network Share . . . . . . . . . . . . . . . . . . . 81 . . . . . . . . . . . . . . . . . . . . 81 . . . . . . . . . . . . . . . . . . . . . . 82 Prerequisites Important System or Feature Behavior Workflow . . . . . . . . . . . . 82 . . . . . . . . . . . . . . . . . . . . .
Prerequisites . . . . . . . . . . . . . . . . . . . Feature or System Behavior Workflow . . . . . . . . . . . 101 . . . . . . . . . . . . . . . . . . . . . 101 References . . . . . . . . . . . . . . . . . . . . Getting and Setting iDRAC Users and Roles 103 . . . . . . . . . . . . . . . . . . . 103 . . . . . . . . . . . . . . . . . . . . . 103 References . . . . . . . . . . . . . . . . . . . . Reporting iDRAC IP Address Change Prerequisites . . . . . . . . . 104 104 . . . . . . . . . . .
B Schema . . . . . . . . . . . . . . . . . . . . . . . . . Lifecycle Log Schema . 117 . . . . . . . . . . . . . . . . . C Easy-to-use System Component Names . . . . . Index 117 . . . . . . . . . . . . . . 119 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
1 Introduction The Dell Lifecycle Controller provides advanced embedded systems management and is delivered as part of iDRAC Express card and embedded Unified Extensible Firmware Interface (UEFI) applications in the 11th generation Dell servers. It includes a 1GB managed and persistent storage that embeds systems management features in addition to the iDRAC features. You can further upgrade to iDRAC Enterprise and the vFlash SD card reader.
• Get and set NIC/CNA and RAID configuration • Get and set BIOS configuration and BIOS passwords • Export lifecycle log and add work notes • Export current and factory shipped hardware inventory log • Manage, attach, and boot to vFlash SD card partitions • Lock the controllers using the local key.
Remote Services Features and Product Classification The Remote Services features that a Dell server supports depend on the system configuration. Table 1-1 shows the product classifications for Remote Services. For example, for a Dell system y71x series, y denotes letters such as M, R, or T; and x denotes numbers. Table 1-1.
Table 1-1.
What’s New in Remote Services • Export the server profile. • Import the server profile. • Configuration and firmware upgrade support for Converged Network Adapters (CNA) cards (10GB paritionable NIC with FCoE and iSCSI offload). Supported on the following CNA cards: – Broadcom: • • M710HD Dual Port 10Gig 57712 NDC Enhancement to the RAID configuration feature: – Create sliced virtual disks — Creating virtual disks using a portion of physical disks. – Supports Enable controller encryption.
Web Services for Management WS-Management is a Simple Object Access Protocol (SOAP)-based protocol designed for systems management. It is published by the Distributed Management Task Force (DMTF) and provides an interoperable protocol for devices to share and exchange data across networks. The Lifecycle Controller Remote Services WS-Management implementation complies with the DMTF WS-Management specification version 1.1.0.
• SM CLP Admin Domain — Defines CIM classes for representing CLP’s configuration. • Power State Management — Defines CIM classes for power control operations. • Command Line Protocol Service — Defines CIM classes for representing CLP’s configuration. • IP Interface — Defines CIM classes for representing an IP interface of a managed system. • DHCP Client — Defines CIM classes for representing a DHCP client and its associated capabilities and configuration.
• Dell OS Deployment — Defines CIM and Dell extension classes for representing the configuration of operating system deployment features. • Dell Software Update Profile — Defines CIM and Dell extensions for representing the service class and methods for updating BIOS, component firmware, Lifecycle Controller firmware, Diagnostics, and Driver Pack.
• Dell Persistent Storage Profile — Describes the classes, properties and methods to represent and manage the partitions on the vFlash SD card on Dell platforms. • Dell BIOS and Boot Management Profile — Describes the classes, properties and methods to represent the configuration of the system BIOS setup and to manage the boot order of the system.
client infrastructure such as Windows WinRM and Powershell CLI, open source utilities like WS-MANCLI, and application programming environments like Microsoft .NET. Other Documents You May Need In addition to this guide, you can access the following guides available at support.dell.com/manuals. On the Manuals page, click Software Systems Management. Click on the appropriate product link on the right-side to access the documents.
Using Remote Services 2 This section describes some of the prerequisites that will help you get started with the Remote Services functionality and use the new features effectively, for better results. Prerequisites for Using Remote Services Web Services Setup Ensure that the following conditions are met while setting the system: • Use the following tools to access Remote Services: • Windows-based client WinRM that is already installed in the operating system, else you can download it from support.
You must configure the client for the connection. For more information, see the Lifecycle Controller Web Services Interface Guide–Windows version. OpenWSMan Client The OpenWSMan client is the WS-Management CLI that is part of the open-source project Openwsman. To download, build, install, and use the WS-Management CLI and OpenWSMan packages from sourceforge.net, see openwsman.org for download links. NOTE: You must configure the client for the connection.
4 Understand how the feature functions and system responses. 5 Execute the steps using the reference table that has location of the task details in the Lifecycle Controller Web Services Interface Guide–Windows and Linux version along with the additional information such as methods, class, input parameters, and output parameters that can be found in the profile document and MOF file.
Using Remote Services
Remote Services Operations 3 This section describes the Remote Services features with high-level descriptions and sample tasks. For more information on the tasks, see the Use Cases section in the individual profile documents at delltechcenter.com/page/DCIM.Library. Managing Auto-Discovery The Auto-Discovery feature allows newly installed servers to automatically discover the remote management console that hosts the Provisioning Server.
support for Auto-Discovery. There are several options for enabling the network environment to support discovery of the Provisioning Server host by unprovisioned servers. One of the following prerequisites must be met for the Auto-Discovery feature to work properly: • The DHCP server provides a comma separated list of Provisioning Server locations using a vendor scope option of class LifecycleController option 1. These locations can be a hostname or IP address and optionally include a port.
c Select Enable to enable the Auto-Discovery feature. NOTE: Auto-Discovery feature does not run if the administrator accounts are enabled. 8 Save and exit iDRAC6 Configuration Utility. 9 Restart your system. Auto-Discovery Workflow This is the Auto-Discovery workflow once it is configured and enabled: 1 Plug in your new Dell system to your network. 2 Plug-in the power cables to turn on the system.
Viewing the Discovery Status on the System You can view the status of the Discovery and Handshake on the LCD (running, stopped, suspended, or complete.) After the system is connected to the network: Use the Auto-Discovery setup on iDRAC Option ROM (CTRL+E) to set the Auto-Discovery status, save and exit. The LCD displays the status as running. If the discovery process is running, you can view its progress code that corresponds to how far the last attempt reached (i.e.
• Auto-Discovery feature does not use the newly set provisioning server IP address/hostname for any handshakes in progress, but is used only during the next handshake process. • Auto-Discovery feature supports setting multiple IP addresses and/or host names using the following format: • The string is a list of IP addresses and/or host names and ports separated by comma. • Hostname is qualified. • IPv4 address – starts with ‘(‘ and ends with ‘)’ when specified at the same time with a hostname.
2 Navigate to the LAN User Configuration screen and select the Provisioning Server. 3 Type the IP/hostname string of the Provisioning Server host and click Enter. 4 Save and Exit the iDRAC6 Configuration Utility. Remotely Reinitiating Auto-Discovery in New Environments This feature allows you to reinitiate Auto-Discovery through WSManagement, even though Auto-Discovery may have taken place earlier. Use this feature to move a server from one data center to another.
The described interfaces are specified in the Dell Lifecycle Controller Management Profile available at delltechcenter.com/page/DCIM+Extensions+Library. Managed Object Format (MOF) files for related class and method definitions are also available in the Dell TechCenter DCIM Extensions Library area. The interfaces are: ReinitiateDHS (ProvisioningServer, ResetToFactoryDefaults and , PerformAutoDiscovery) • ProvisioningServer: Optional parameter to indicate the Provisioning Server information.
Creating Custom Trusted Root Client Certificates for the Provisioning Server The DownloadClientCerts() method on the DCIM_LCService class can be called to generate a custom signed Auto-Discovery client certificate. The method takes as input a Certificate Authority generated key certificate and related hash and password parameters. The key certificate provided is used to sign a certificate containing the system service tag as the Common Name (CN).
Use the DeleteAutoDiscoveryClientCerts() method on the DCIM_LCService class to delete a client certificate and private key. Changing the Web Server/WS-Management Encryption Certificate and Private Key from PKCS #12 1 Generate a CSR and private key. The CSR needs to be signed by a CA. 2 Combine the certificate with the private key then encrypt it into a PKCS#12 file. 3 BASE64 encode the PKCS#12 file to convert it from binary to text so you can pass it as a WS-Management parameter.
definition (.mof) files can be found at the Lifecycle Controller area on the Dell Enterprise Technology Center at delltechcenter.com.
Important • The drivers unpacked and attached are removed after the time specified in ExposeDuration parameter or if no time is specified in the method invocation then by default the OEMDRV USB device is removed after 18 hours. • Ensure that network based ISO images attached during the process are detached before you use Unified Extensible Firmware Interface (UEFI) System Service. • When installing Red Hat Linux 5.
• The GetNetworkISOImageConnectionInfo() method provides the ISO Image connection information in the form of several output parameters that include network share information (excluding password), ISO connection, and attached status. • The SkipISOImageBoot() method does not allow the host system to boot to the ISO Image after a system reboot. After one reboot host continues to boot to the ISO Image.
can be checked to see what state the job is in and whether it completed successfully or encountered a problem and failed. If a job failure occurs, the job instance also contains an error message property that provides detailed information on the nature of the failure. Other properties contain other error identification information that can be used to localize the error message to the supported languages and get more detailed error descriptions and recommended response action descriptions.
• It is recommended that the latest driver pack is installed so that they are available for newer operating systems. • Provisioning console, application or appropriate scripts that are capable of sending WS-Management Web services requests and method invocations. Workflow The following is a typical workflow for remote operating system deployment: • Create the custom pre-operating system/operating system image and share it on the network, or create the required operating system media ISO image.
WS-Management Methods Important If the supported SD card is installed and not formatted, executing the download ISO command will first format the SD card and then download to ISO image. The WS-Management methods under the operating system deployment profile for vFlash are: • DownloadISOToVFlash — Downloads the image to the vFlash. Support is available for CIFS, TFTP and NFS. • BootToISOFromVFlash — Boots to the ISO image that has been staged on the vFlash.
Boot to ISO Methods Comparison Table 3-1.
services to perform the updates. Although the updates may involve intermediate BIOS restarts, Lifecycle Controller will automatically handle them until the updates are complete. This feature supports two methodologies to perform updates: • Install from Uniform Resource Identifier (URI) — This methodology allows a WS-Management request to install or update software on a host platform using a URI. The URI consists of a string of characters used to identify or name a resource on the network.
• USC • Diagnostics Workflow for Remote Update from URI 1 Use the appropriate WS-Management client to send a method invocation request to the iDRAC IP address. The WS-Management command includes the InstallFromURI() method on the DCIM_SoftwareInstallationService, and the location from where iDRAC should download the Dell Update Package (DUP). The download protocols that are supported are FTP, HTTP, CIFS, NFS, and TFTP.
Scheduling Remote Update The remote update scheduling capability provides the ability to schedule or stage firmware updates now or in the future. Updates for Diagnostics and USC can be performed directly and do not require any staging. These updates will be applied as soon as they are downloaded and do not need the Job Scheduler. All other remote updates are staged updates, and require scheduling, using different scheduling options.
Remote Scheduling Types Immediate Update To immediately update component firmware, schedule the update and reboot jobs with start time as TIME_NOW. Scheduling a reboot or update is not required for updates to the Lifecycle Controller components like USC and Diagnostics. The updates are immediate for these components. Scheduled Update Specifying a scheduled start time for one or more jobs using the SetupJobQueue() method involves specifying a date and time value for the StartTimeInterval parameter.
• Reboot 3 - Graceful reboot with forced shutdown — Performs the Graceful Shutdown of the managed server and if the system is powered off within the PowerCycle Wait Time, it powers the system back up and marks the reboot job as Reboot Completed. If the system is not powered off within the PowerCycle WaitTime, the system is Power Cycled.
Validating vFlash presence Using WS-Management To ensure that the system is equipped with a Dell-licensed vFlash card follow these steps: 1 Using an application, script or command line shell that can process WSManagement based web services requests, send a get instance request for the DCIM_LCEnumeration class instance with the InstanceID of DCIM_LCEnumeration:CCR1.
The set action is performed by invoking the SetAttribute() method on the DCIM_LCService class. The SetAttribute() method takes as input parameters the property names and values. Table 3-2 lists the values of the part firmware and configuration update: Table 3-2.
The firmware inventory feature will return an inventory of the installed firmware on devices on the system and the inventory of available BIOS/firmware on the iDRAC6 express card Lifecycle Controller. It also returns the inventory of both the currently installed version of BIOS /Firmware on the iDRAC6 Express card and the versions available for rollback (N and N-1 versions) that can be installed using the remote update Web services interface.
The instant firmware inventory class provides firmware inventory information on: • The firmware installed on the supported devices • The firmware versions available for installation for each device Firmware Inventory Using WS-Management The Dell Software Inventory profile defines the Dell CIM data model extensions that represent installed and available to be installed versions of firmware and embedded software on the server.
compid> :< version>. For the rollback operation pick the InstanceID Value from the Available instance, DCIM:AVAILABLE:::. You will not be able to edit InstanceID values. NOTE: If the version string property value of Available Software Instance is equal to the Installed Software Instance, then the InstanceID value of that Available Software Instance should not be used for the rollback operation.
Exporting Current Hardware Inventory • To export the current hardware inventory to an XML file, invoke the ExportHWInventory() method on the DCIM_LCService class. • To store a copy of the factory defaults of a managed node, invoke the ExportFactoryConfiguration() method on the DCIM_LCService class. For more information on the schema, see the Lifecycle Log Schema. NOTE: Store the XML file on an USB device or network share, or both the locations.
• Events (update and configuration only) based on severity, category, and date. NOTE: The details of the configuration changes are not shown. • Customer comments based on date. NOTE: Lifecycle log is available even if the OS is not installed on the system and is independent of the power state of the system. Exporting Lifecycle Log Use this feature to export the Lifecycle Log information to an XML file. Store the XML file on an USB Device or network share, or both the locations.
Displaying the NIC/CNA Inventory • Perform the Enumerate operation on the DCIM_NICView class to display the instance properties of all (Broadcom and Intel) the NICs/CNAs embedded in the system. • Perform the Get operation on the class using the correct instance IDs of the required NIC/CNA to display the related properties.
7 Invoke the CreateTargetedConfigJob() method to apply the pending values. If this method is successful, the system must return a job ID for the configuration task you created. NOTE: The system must reboot to execute the task of setting the attribute or attributes. 8 You can query the status of the jobID output using the job control profile methods. 9 Repeat step 1 to confirm successful execution of the method.
4 Before invoking the CreateTargetedConfigJob() method, construct the input parameters (Target, RebootJobType, ScheduledStartTime, UntilTime, and so on). If more than one partition on a port has a configuration change, do not specify RebootJobType and ScheduledStartTime. Schedule the job using the job control profile methods. Go to step 6 to create the jobs. NOTE: See the Simple NIC Profile document at delltechcenter.com/page/DCIM.Library to see the list of all the supported input parameters.
Displaying the Inventory of vFlash SD Card Perform the Enumerate operation on the DCIM_VFlashView class to display all the properties of the vFlash SD card; such as Available size, Capacity, Licensed, and Health, Enable/Disable state, Initialized state, and Write protected state. Displaying the Partitions on vFlash SD Card Perform the Enumerate operation on the DCIM_OpaqueManagementData class to display all the partitions and their properties; such as partition ID, its size and data format.
Managing RAID Configuration Use the RAID configuration feature to get the properties of the RAID controller, physical disks, and the enclosures attached to the system. You can configure different attributes of the physical and virtual disks using the available methods. For more information on the RAID profile, see the RAID Profile.
7 Before invoking the CreateTargetedConfigJob() method, construct the input parameters and use the correct Fully Qualified Device Descriptor (FQDD) for the controller. 8 Invoke the CreateTargetedConfigJob() method to apply the pending values. 9 Query the status of the jobID output using the job control profile methods. The system is rebooted based on the time specified. 10 Enumerate the DCIM_VirtualDiskView class to view the virtual disk created earlier.
NOTE: The system must reboot to execute the task of setting the attribute or attributes. 8 Query the status of the jobID output using the job control profile methods. 9 Repeat step 1 to confirm successful execution of the method. One Time Boot Use the boot management methods to perform one time boot to a BIOS boot device. If you try to one time boot to a vFlash partition that is not attached, Remote Services automatically attaches it and returns a job ID. You can query the job using this ID.
Using Job Control Use this feature to do the following: • Reporting all Jobs - Enumerate the DCIM_ConcreteJob class to report all the jobs. • Reporting scheduled Jobs - Enumerate the DCIM_ConcreteJob class with a selection filter of JobStatus=Scheduled to generate a report of all the scheduled jobs. • Scheduling Jobs and Job Queues - You can run multiple jobs in a single reboot of the system using the SetupJobQueue() method on the DCIM_JobService class.
SetupJobQueue() method invocation. If a reboot job is not included in the Job Queue setup, the jobs are ready to run at the scheduled start time but rely on an external actor to restart the system and get the job execution started. Running Multiple Target Jobs To run multiple target jobs (for example, setting NIC attributes on multiple NICs) at one time: 1 Configuring Embedded NIC 1: a Set the NIC attributes for Embedded NIC 1.
• mm is the minute • ss is the second For example, 20090930112030 — You must type the date and time in this format for all the Lifecycle Controller updates, set attributes, and CreateTargetedConfigJob() methods on different service classes. TIME_NOW is a special value that represents running the tasks immediately.
Remote Services Profiles 4 This section provides high-level information on the individual profiles. For more information on the profiles and the related MOFs, see delltechcenter.com/page/DCIM.Library. For examples of WinRM and WS-Management command line invocations, see: • delltechcenter.
• The DetachDrivers() method detaches the USB device containing the drivers from the host server. • The UnpackAndShare() method extracts the drivers for the selected operating system, and copies them to the specified network share. • The BootToNetworkISO() method is used to boot the system to an ISO image located on a CIFS or NFS network share. • The DetachISOImage() method detaches the ISO Image from the host server.
LC Service Methods The following methods are used to set attributes related to Auto-Discovery, Part Replacement and IO Identity. • The SetAttribute() method is used to set the value of a single attribute. • The SetAttributes() method is used to set the values of multiple attributes. • The CreateConfigJob() method is used to apply the pending values set by the SetAttribute() and SetAttributes() methods.
Lifecycle Log Methods • The LCWipe() method is used to wipe all configurations from the Lifecycle controller before the system is retired. • The ExportLifecycleLog() method is used to export the log from the Lifecycle Controller to a file on a remote share. • The InsertCommentInLCLog() method is used to insert additional user comments into the Lifecycle Controller log.
Table 4-3. Simple NIC Profile Class Name Functions Operations Methods • DCIM_NICInteger Use this sub-class to display the Get SetAttributt properties of NIC integer instances. Enumerate e() SetAttribute s() • DCIM_NICString Use this sub-class to display the properties of NIC string instances. Get SetAttributt Enumerate e() SetAttribute s() Simple NIC Methods These methods are used to apply NIC, FCOE, and iSCSI attributes to LAN on motherboards, add-in NICs, and CNAs in the system.
BIOS and Boot Management Profile Table 4-4 lists the classes, functions, operations, and methods under the BIOS and Boot Management profile. Table 4-4. BIOS and Boot Management Profile Class Name Functions Operations Methods BIOS Management DCIM_BIOSService Use this central class to modify Get See BIOS and the BIOS attributes. Enumerate Boot Invoke Management Methods DCIM_BIOSEnume Use this sub-class to display ration the properties of BIOS enumeration instances.
BIOS and Boot Management Methods The methods are used to apply attributes and change the boot configurations in the system. Each of the methods have their own set of input and output parameters. The methods have specific return code values. The following methods are used under BIOS and boot management: • The SetAttribute() method is used to set or change the value of a BIOS attribute. • The SetAttributes() method is used to set or change the values of a group of attributes.
Table 4-5. Persistent Storage Profile Class Name Functions Operations Methods DCIM_PersistentSto Use this central class to define the Get See vFlash rageService extrinsic methods. Enumerate SD Card Methods Invoke DCIM_VFlashView Use this class to display the Get NA different instance IDs and related Enumerate properties of all the vFlash SD cards attached to a system. DCIM_OpaqueMan Use this sub-class to display the agementData available partitions on a specific vFlash SD card.
• The ExportDataFromPartition() method is used to copy or export the contents of a vFlash SD card partition to a local or remote location as an image file in the .img or .iso format.
RAID Profile Table 4-6 lists the classes, functions, operations, and methods under the RAID profile. Table 4-6. RAID Profile Class Name Functions Operations Methods DCIM_RAIDService This is the central class. It defines the extrinsic methods. Get See Enumerate RAID Invoke Methods DCIM_ControllerVi Use this class to display the different ew instance IDs and related properties of the controllers attached to a system.
RAID Methods The RAID methods are used to apply attributes to different RAID components. Each of the methods have their own set of input and output parameters. The methods have specific return code values. The different methods under the RAID service class are: • The AssignSpare() method is used to assign a physical disk as a dedicated hot spare for a virtual disk, or as a global hot spare. • The ResetConfig() method is used to delete all virtual disks and un-assign all hot spare physical disks.
• The CreateTargetedConfigJob() method is used to apply the pending values created by other methods. The successful execution of this method creates a job for application of pending attribute values. NOTE: Subsequent calls to the CreateTargetedConfigJob() method after the first CreateTargetedConfigJob() method results in an error until the first job is completed.
Hardware Inventory Profiles Table 4-7 lists the classes, functions, operations, and methods for different hardware on the managed node. Table 4-7. Hardware Inventory Profiles Class Name Functions Operations Methods CPU Profile DCIM_CPUView Use this class to get the instance Get NA information of all the CPUs and Enumerate associated cache available in the system. Fan Profile DCIM_FanView Use this class to get the instance information of all the fans available in the system.
Table 4-7. Hardware Inventory Profiles (continued) Class Name Functions Operations Methods DCIM_PowerSupply Use this class to get the instance View information of all the power supply units available in the system. Get NA Enumerate System View Profile DCIM_SystemView Use this class to get the general details Get NA about the system like System Enumerate Manufacturer, Model, Service Tag, Total Memory, BIOS Version, System ID, Asset Tag, Power State, and so on.
5 Use Case Scenarios Common Prerequisites To successfully perform remote operations on the server, make sure that the following prerequisites are met: • USC-LCE version 1.5 is installed. • iDRAC firmware version 3.2 (Blade systems) or 1.7 (Rack and Tower Systems) is installed. • Latest BIOS version is installed. For more information on the BIOS versions related to the Dell systems, see the latest Remote Services Release Notes. • A WS-Management capable utility is available to perform the tasks.
Prerequisites To successfully perform remote operations on the server, make sure that the following prerequisites are met: • Common Prerequisites. • The server has a valid 7 character service tag. • iDRAC vFlash card: • – Is installed, enabled, and initialized. – Minimum free space of 384 MB is available. Network Share: – Permissions and firewall settings are provided for the iDRAC to communicate with the system that has the network share. – iDRAC vFlash card is installed as a license.
• If you do not use the ScheduledStartTime parameter, it returns a job id, but is not scheduled. To schedule the job, invoke the SetupJobQueue() method. • You can cancel an export job before it starts using the DeleteJobQueue() method. After the job starts, use Ctrl+E during POST and select Cancel System Services, or reset iDRAC. This initiates the recovery process and puts the system into a previously known state. Recovery is within 5 minutes.
Example: The currently installed BIOS firmware version is 2.1, and version 2.0 is the rollback (2.0 was the previous version before installing 2.1). After export, the currently installed BIOS firmware version 2.1 is backed up. Workflow 1 Construct the input parameters depending on where backup image file is stored; iDRAC vFlash card or network share (CIFS or NFS). 2 Invoke the BackupImage() method. A job id (for example, JID_001291194119) is returned to the screen.
Table 5-1. Step Number and Location Step Number Location in Lifecycle Controller Web Services Interface Guide (Windows or Linux) Profiles DCIM-LCManagementProfile MOFs DCIM_LCService.mof Importing Server Profile from a iDRAC vFlash Card or a Network Share Import the backup of the firmware and configuration (server and firmware) and restore it to the same system the backup was taken from. NOTE: If the motherboard is replaced, make sure to re-install the hardware back in the same location.
• If the motherboard is replaced before import is performed, make sure that the motherboard has the latest iDRAC and BIOS installed. Important • User Data is not present in the backup image file. Deleting the configuration removes the user data. • During import, make sure that operations such as firmware update, operating system deployment, and firmware configurations are not running.
• Import does not restore diagnostics or driver pack information. • By default, import preserves the current virtual disk configuration. NOTE: If you want to delete the current virtual disk configuration and restore the configuration from the backup image file, use the PreserveVDConfig parameter with a value of 0. This does not restore content that was on the virtual disk during the backup (for example, Operating System), but only creates a blank virtual disk and sets the attributes.
3 To get the status on percentage completion of the job, execute required command on the job id. NOTE: Besides querying the job id using WS-Management, you can also check the iDRAC RAC logs for job status progress. After job status displays Completed, you can check the Lifecycle Logs for all backup entries. To view the log, export the log using the ExportLifecycleLog() method on the DCIM_LCService class or view the log in the Unified Server Configurator–Lifecycle Controller Enabled GUI.
Post-restore Scenario • • The following operations are performed: a System powers off if turned on. If the operating system is running, it attempts to perform a graceful shutdown, else it performs a forced shutdown after 15 minutes. b System restores all the Lifecycle controller content. c System powers on and boots into System Services to execute tasks to perform firmware restore for supported devices (BIOS, Storage Controllers and Add-in NIC cards).
Configuring RAID Set up and configure RAID with the following hardware resources: • Storage Controller — PERC • Physical Disks (SEDs) — 4 • Size of each Physical Disk — 1 TB RAID Setup • Size of each Virtual Disk: 10 GB (10240 MB) • Number of virtual disks — 10 • RAID Level — 5 • Dedicated Hot Spare — 1 • Lock the controller with a local key Prerequisites To successfully perform remote operations on the server, make sure that the following prerequisites are met: • Common Prerequisites • P
2 Get the FQDDs and values of the physical disks attached to the required controller. 3 Run the CreateVirtualDisk() method after setting the correct values shown in Table 5-3: Table 5-3. Values for the RAID Set Up Parameter Value FQDD Of the controller and the attached physical disks RAID Level Set RAID level as 5. RAID 5 stripes data across the physical disks, and uses parity information to maintain redundant data. If a physical disk fails, the data is rebuilt using the parity information.
Table 5-3. Values for the RAID Set Up Parameter Value Stripe Size The stripe element size is the amount of disk space a stripe consumes on each physical disk in the stripe.
• Fully Qualified Device Descriptor (FQDD) of the controller. • Encryption Mode — Local Key Encryption. • Key ID. • Passphrase — A valid passphrase contains 8 to 32 characters. It must include a combination of uppercase and lowercase letters, numbers, symbols, and without spaces. Assigning the Hot Spare 7 Use the FQDD of the physical disk and related virtual disks that is used as the spare and invoke the AssignSpare() method.
References NOTE: The sections referenced in this table contain only generic examples. Table 5-4. Step Number and Location Step Number Location in Lifecycle Controller Web Services Interface Guide (Windows or Linux) step 1 16.7 — Listing the RAID Inventory-ControllerView Class step 2 16.9 — Listing the RAID Inventory-PhysicalDiskView Class step 3 16.18.5 — Creating a Sliced Virtual Disk-CreateVirtualDisk step 4 16.18.5 — Creating a Sliced Virtual Disk-CreateVirtualDisk step 5 16.
Table 5-4. Step Number and Location Step Number Location in Lifecycle Controller Web Services Interface Guide (Windows or Linux) DCIM_ControllerView.mof DCIM_EnclosureView.mof DCIM_PhysicalDiskView.mof DCIM_RAIDAttribute.mof DCIM_RAIDEnumeration.mof DCIM_RAIDInteger.mof DCIM_RAIDService.mof DCIM_RAIDString.mof DCIM_VirtualDiskView.
Changing the Personality and Bandwidth of a Partition for a CNA Partition a port and assign the personality and bandwidth on a Converged Network Adapter card with a 10Gb ethernet link with multiple personality support. Personality and Bandwidth Setup Table 5-5.
NOTE: On a partition, as multiple personalities are supported, you can either enable or disable multiple personalities at the same time. For limitations on the setting the personalities on different CNA cards, see the Release Notes or the Simple NIC Profile document at delltechcenter.com/page/DCIM.Library. 3 Go to step 6 to complete the remaining steps.
8 Invoke the CreateTargetedConfigJob() method to apply the pending values. If this method is successful, the system must return a job ID for the configuration task you created. NOTE: The system must reboot to execute the task of setting the attribute or attributes. 9 Create a reboot job with CreateRebootJob() and schedule all the partition jobs and the reboot job using SetupJobQueue(). Pending changes on the partitions are lost if they are not scheduled to run together.
Table 5-7. Step Number and Location Step Number Location in Lifecycle Controller Web Services Interface Guide (Windows or Linux) MOFs DCIM_NICView, DCIM_NICString, DCIM_NICEnumeration, DCIM_NICInteger, DCIM_NICAttribute, and DCIM_NICService Setting the Virtual Address Attributes Change the virtual address attribute on a CNA card. NOTE: All virtual address attributes are reset to default if the system is disconnected from AC power supply.
References NOTE: The sections referenced in this table contain only generic examples. Table 5-8. Step Number and Location Step Number Location in Lifecycle Controller Web Services Interface Guide (Windows or Linux) - 15.10 — Setting the VirtMacAddr Attribute Profiles DCIM-Simple_NIC_Profile MOFs DCIM_NICView, DCIM_NICString, DCIM_NICEnumeration, DCIM_NICInteger, DCIM_NICAttribute, and DCIM_NICService Setting the Boot Target–ISCSI and FCoE Change the iSCSI and FCoE attributes on a CNA card.
• • To set iSCSI first target, set appropriate values to each for the following: – IscsiInitiatorIpAddr – IscsiInitiatorSubnet – IscsiInitiatorSubnetPrefix – IscsiInitiatorGateway – IscsiInitiatorPrimDns – IscsiInitiatorSecDns – IscsiInitiatorName – IscsiInitiatorChapId – IscsiInitiatorChapPwd To configure FCoE boot target, set appropriate values for each of the following: – MTUParams – ConnectFirstFCoETarget – FirstFCoEWWPNTarget – FirstFCoEBootTargetLUN – FirstFCoEFCFVLANID G
Table 5-9. LAN Attributes Attribute Description Values VLAN Priority Sets the VLAN ID priority value. Legal values are defined 0 to 7 by IEEE 801.11g specification. Auto Negotiate When auto-negotiate is on, it determines whether iDRAC On or Off automatically sets the Duplex Mode and Network Speed values by communicating with the nearest router or hub. When auto-negotiate is off, you must set the Duplex Mode and Network Speed values manually.
Table 5-10. LAN User Configuration Parameter Description Smart Card Authentication Smart Card Authentication for iDRAC log in. Enable, Disable or If enabled, install a Smart Card is installed to Enable with access the iDRAC. RACADM Table 5-11. Value Virtual Media Connection Mode Mode Description Attached The virtual media devices are available for use in the current operating environment.
Table 5-12. IPv4 Configuration Attribute Description Values DNS Server 1 (Primary DNS Server) iDRAC acquires the IP address for the DNS server 1 Maximum value of from the Dynamic Host Configuration Protocol 255.255.255. (DHCP). 255 DNS Server 2 iDRAC acquires the IP address for the DNS server 2 Maximum value of (Secondary DNS from the Dynamic Host Configuration Protocol 255.255.255. Server) (DHCP). 255 Table 5-13.
Prerequisites To successfully perform remote operations on the server, make sure that the following prerequisites are met: • Common Prerequisites Feature or System Behavior • Is available by default. • A reboot is not required after setting iDRAC configuration. Workflow 1 Enumerate the DCIM_iDRACCardAttribute class to identify all the current instances of this class (all the iDRAC configuration attributes).
Table 5-14. Step Number and Location Step Number Location in Lifecycle Controller Web Services Interface Guide (Windows or Linux) step 2 19.2 — Getting an iDRAC Card Enumeration Instance step 3 19.4.1 — Changing iDRAC Values-ApplyAttributes() (Immediate) step 5 19.4.2 — Poll job completion step 6 19.4.3 — Set Attribute Verification Profiles DCIM-iDRAC_Card_Profile MOFs DCIM_iDRACCardEnumeration.mof DCIM_iDRACCardInteger.mof DCIM_iDRACCardService.mof DCIM_iDRACCardString.mof DCIM_iDRACCardView.
Getting and Setting iDRAC Users and Roles Set up the iDRAC user names, password and assigning roles to the users.
Table 5-15. Step Number and Location Step Number Location in Lifecycle Controller Web Services Interface Guide (Windows or Linux) Profiles DCIM-iDRAC_Card_Profile MOFs DCIM_iDRACCardEnumeration.mof DCIM_iDRACCardInteger.mof DCIM_iDRACCardService.mof DCIM_iDRACCardString.mof DCIM_iDRACCardView.mof Reporting iDRAC IP Address Change To report Service Tag or IP address change from iDRAC to SCCM. An Simple Object Access Protocol (SOAP) message is sent to indicate iDRAC IP address change.
Workflow Using the administrator account set the IPChangeNotification attribute. Optionally, set the Provisioning Server Address. If the IP address of iDRAC changes either due to manual intervention or the DHCP lease expires: • The iDRAC notifies the provisioning servers with the service tag of the server and the new IP address of iDRAC. The provisioning sever can then find the old entry for the server using the service tag and update it.
Setting, Modifying, and Deleting BIOS Password Set or modify the BIOS password. Prerequisites To successfully perform remote operations on the server, make sure that the following prerequisites are met: • Common Prerequisites. • Administrator privileges on iDRAC. • Local status of the current BIOS password.
References NOTE: The sections referenced in this table contain only generic examples. Table 5-17. Step Number and Location Step Number Location in Lifecycle Controller Web Services Interface Guide (Windows or Linux) Setting the password 17.9.1 — Setting the BIOS Password Modifying the 17.9.1 — Setting the BIOS Password password Deleting the password 17.9.1 — Setting the BIOS Password step 2 17.9.2 — Create the Targeted Configuration Job step 3 17.9.
Workflow 1 Invoke the GetRSStatus() method. 2 A status is returned along with a Message, MessageID, and ReturnValue. 3 Continue executing the method with an interval until a Ready Status is returned. 4 Ready status indicates Lifecycle Controller is ready for operations. References NOTE: The sections referenced in this table contain only generic examples. Table 5-18. Step Number and Location Step Number Location in Lifecycle Controller Web Services Interface Guide (Windows or Linux) step 1 20.
Troubleshooting and Frequently Asked Questions 6 Error Messages For more information on the error message IDs and the recommended actions, see Dell Lifecycle Controller Remote Services Error Messages and Troubleshooting List on support.dell.com/manuals. To view the error message and related information, select the error message ID from the Error Message ID drop-down list. Additionally, you can download the detailed error message registry from delltechcenter.com/page/Lifecycle+Controller.
Table 6-2. Auto-Discovery Messages Message 2 Resolutions Stopped (default) N/A Started N/A Auto Discovery disabled Enable auto-discovery. Blocked Admin Account Enabled Disable all the administrative accounts. Blocked Active Directory Enabled Disable the active directory. Blocked IPv6 Enabled Disable IPv6. Blocked No IP on NIC Enable the NIC. No Provisioning Server Found Check the value of psinfo in the BIOS.
Table 6-2. Auto-Discovery Messages Message 2 Resolutions SOAP failure The provisioning server does not support the getCredentials() SOAP call. Verify that the provisioning server supports auto-discovery and the provisioning server information is set correctly in the DHCP vendor option, DNS SRV record, or BIOS. No credentials returned Check that the service tag is in the list of known servers on the provisioning server.
4 What is Remote Services or Remote Enablement? Remote Services is a general term that refers the capability of enabling users to remotely connect to the target servers and perform systems management operations. 5 How to set the network configuration to use Remote Services? Use the ping utility to verify the connection between the client and managed server. Ensure that the client and network allows HTTP and SSL protocols.
Lifecycle Controller Web Services Interface Guide–Windows and Linux version. 11 What do I do when a fatal error occurs followed by a red screen? Perform a cold reboot of the system when the red screen is displayed. 12 Do I need to install an operating system (OS) to access USC or Remote Services? OS is not required to access USC or remote service. 13 Which UEFI version is supported? 32 bit or 64 bit? UEFI supports 64 bit.
20 Are there ways to improve response time for getting PCIDeviceView using WinRM? Yes. Setting the WinRM configuration by executing the following command reduces the time taken by PCIDeviceView enumeration. #winrm set winrm/config @{MaxBatchItems="100"} 21 How to clear jobs? a Enumerate DCIM_LifecycleJobs to list all the jobs in Lifecycle Controller. b Use DeleteJobqueue() method to delete particular jobs.
27 Why are the NIC Blink LED attributes always set to NULL after the job is completed? A blink LED NIC attribute is a one time setting that you are able to set, but once SSIB task is complete, it will set the current value back to null. The purpose of this attribute is to blink the NIC LEDs for a certain amount of time (seconds). 28 How many attributes can I set through the SetAttribute() method. You can set only one attribute through the SetAttribute() method.
Troubleshooting and Frequently Asked Questions
A Schema This section displays a typical schema for lifecycle log. Lifecycle Log Schema PAGE 118
Easy-to-use System Component Names B Table B-1 lists the Fully Qualified Device Descriptor (FQDD) of the system components and the equivalent easy-to-use names. Table B-1. Easy-to-use Names of System Components FQDD of System Component Name Easy-to-use Name RAID.Integrated.1 Integrated RAID Controller RAID.Slot.1-1 RAID Controller in Slot 1 NIC.Mezzanine.1B-1 NIC.Mezzanine.1C-1 NIC.Mezzanine.1C-2 NIC in Mezzanine NIC.Mezzanine.3C-2 NonRAID.Integrated.1-1 Integrated Storage Controller NonRAID.
Table B-1. Easy-to-use Names of System Components (continued) FQDD of System Component Name Easy-to-use Name P2PBridge.Mezzanine.2B-1 Embedded Host Bridge in Mezzanine 1 (Fabric B) USBUHCI.Embedded.1-1 Embedded USB UHCI 1 USBOHCI.Embedded.1-1 Embedded USB OHCI 1 USBEHCI.Embedded.1-1 Embedded USB EHCI 1 Disk.SATAEmbeded.A-1 Disk on Embedded SATA Port A Optical.SATAEmbeded.B-1 Optical Drive on Embedded SATA Port B TBU.SATAExternal.C-1 Tape Back-up on External SATA Port C Disk.USBFront.
Table B-1. Easy-to-use Names of System Components (continued) FQDD of System Component Name Easy-to-use Name Fan.Slot. 1 Fan 1 Fan.Slot. 2 Fan 2 … … Fan.Slot. 9 Fan 9 MC.Chassis.1 Chassis Management Controller 1 MC.Chassis.2 Chassis Management Controller 2 KVM.Chassis.1 KVM IOM.Slot.1 IO Module 1 … … IOM.Slot.6 IO Module 6 PSU.Slot.1 Power Supply 1 … ... PSU.Slot.6 Power Supply 6 CPU.Socket.1 CPU 1 System.Modular.2 Blade 2 DIMM.Socket.
Easy-to-use System Component Names
Index A E auto-discovery enable, 26 Export Server Profile about, 79 B I BIOS set, modify, and delete, 106 iDRAC getting and setting, 101 IP address change, 104 user roles, 103 C Import Server Profile about, 82 Certificates managing, 31 CNA Bandwidth, 93 Boot Target, 96 Personality, 92 Virtual Address, 95 J Job Control, 60 L D Deleting Configuration, 52 Log export hardware inventory, 51 export lifecycle log, 52 deployment interfaces, 20 DHCP/DNS configure, 25 P Profile BIOS and boot, 68 LC man
OS deployment, 63 other Hardware, 75 persistent storage, 69 RAID configuration, 72 T troubleshooting, 109 Types of remote scheduling, 44 R V RAID Hot Spare, 89 Local Key, 88 Virtual Disk, 86 vFlash SD Card, 55 RAID configuration, 57 web services for management, 16 Remote Operating System Deployment, 33 WS-MAN, 16 remote operating system deployment, 33 deployment interface, 33 main features, 33 prerequisites and dependencies, 37 use case, 37 workflow, 38 Remote Service Status, 107 remote services,
