Dell Lifecycle Controller 2 Web Services Interface Guide
Dell Lifecycle Controller Web Services
Interface Guide for Windows
A Dell Technical White Paper about the Best Practices to be followed for using the
WS-Man—based Remote Services provided by iDRAC and Lifecycle Controller
Dell Engineering
December 2013
A Dell Best Practices
Date
Description
August 2013
Initial release
Revisions
Dell, the DELL logo, and the DELL badge are trademarks of Dell Inc. Symantec, NetBackup, and Backup Exec are
trademarks of Symantec Corporation in the U.S. and other countries. Microsoft, Windows, and Windows Server are
registered trademarks of Microsoft Corporation in the United States and/or other countries. Other trademarks and
trade names may be used in this document to refer to either the entities claiming the marks and names or their
products. Dell disclaims any proprietary interest in the marks and names of others.
Dell™, the Dell logo, Dell Boomi™, Dell Precision™ ,OptiPlex™, Latitude™, PowerEdge™, PowerVault™,
PowerConnect™, OpenManage™, EqualLogic™, Compellent™, KACE™, FlexAddress™, Force10™ and Vostro™ are
trademarks of Dell Inc. Other Dell trademarks may be used in this document. Cisco Nexus®, Cisco MDS®, Cisco NX0S®, and other Cisco Catalyst® are registered trademarks of Cisco System Inc. EMC VNX®, and EMC Unisphere® are
registered trademarks of EMC Corporation. Intel®, Pentium®, Xeon®, Core® and Celeron® are registered trademarks of
Intel Corporation in the U.S. and other countries. AMD® is a registered trademark and AMD Opteron™, AMD
Phenom™ and AMD Sempron™ are trademarks of Advanced Micro Devices, Inc. Microsoft®, Windows®, Windows
Server®, Internet Explorer®, MS-DOS®, Windows Vista® and Active Directory® are either trademarks or registered
trademarks of Microsoft Corporation in the United States and/or other countries. Red Hat® and Red Hat® Enterprise
Linux® are registered trademarks of Red Hat, Inc. in the United States and/or other countries. Novell® and SUSE® are
registered trademarks of Novell Inc. in the United States and other countries. Oracle® is a registered trademark of
Oracle Corporation and/or its affiliates. Citrix®, Xen®, XenServer® and XenMotion® are either registered trademarks or
trademarks of Citrix Systems, Inc. in the United States and/or other countries. VMware®, Virtual SMP®, vMotion®,
vCenter® and vSphere® are registered trademarks or trademarks of VMware, Inc. in the United States or other
countries. IBM® is a registered trademark of International Business Machines Corporation. Broadcom® and
NetXtreme® are registered trademarks of Broadcom Corporation. Qlogic is a registered trademark of QLogic
Corporation. Other trademarks and trade names may be used in this document to refer to either the entities claiming
the marks and/or names or their products and are the property of their respective owners. Dell disclaims proprietary
interest in the marks and names of others.
2 Dell Lifecycle Controller Web Services Interface Guide for Windows
3 Dell Lifecycle Controller Web Services Interface Guide for Windows
Contents
Revisions ............................................................................................................................................................................................. 2
Executive Summary ........................................................................................................................................................................ 14
1 Introduction .............................................................................................................................................................................. 15
2 References ................................................................................................................................................................................ 16
3 Overview.................................................................................................................................................................................... 17
3.1 Format for WinRM CLI Examples in Document....................................................................................................... 17
3.2 WS-Man Security and Time Parameters ................................................................................................................... 18
3.2.1 Encryption Certificate Security ................................................................................................................................... 18
3.2.2 Handling Invalid Responses from WS-Man Commands ........................................................................................ 18
3.2.3 Improving WinRM Enumeration Performance ........................................................................................................ 19
3.2.4 Specifying StartTime, Until Time, and TIME_NOW Parameters ........................................................................... 19
3.2.5 Return Values ................................................................................................................................................................. 20
3.2.6 Glossary .......................................................................................................................................................................... 20
4 Discovery ................................................................................................................................................................................... 22
4.1 Discovering Web Service Capability .......................................................................................................................... 22
4.2 Discovering the Implemented Profiles ...................................................................................................................... 22
4.3 Discovering Implementation Namespace ................................................................................................................ 23
5 Managing iDRAC Local User Accounts ................................................................................................................................ 26
5.1 Description of iDRAC Attributes Versus Standard DMTF Model ........................................................................... 26
5.2 Account Inventory (Using iDRAC Attributes) ............................................................................................................ 26
5.2.1 Account and Capabilities (Using iDRAC Attributes) ................................................................................................ 26
5.2.2 Privilege and Capabilities (Using iDRAC Attributes) ................................................................................................ 28
5.3 Manage Account Settings (Using iDRAC Attributes) ............................................................................................... 29
5.3.1 Modify User Name (Using iDRAC Attributes) ........................................................................................................... 29
5.3.2 Modify Password (Using iDRAC Attributes) .............................................................................................................. 30
5.3.3 Modify Account State (Using iDRAC Attributes) ...................................................................................................... 31
5.3.4 Modify User Privilege (Using iDRAC Attributes) ....................................................................................................... 32
5.4 Account Inventory (Using DMTF Model) ................................................................................................................... 33
5.4.1 Account and Capabilities (Using DMTF Model) ....................................................................................................... 34
5.4.2 Privilege and Capabilities (Using DMTF Model) ....................................................................................................... 37
5.5 Manage Account Settings (Using DMTF Model) ..................................................................................................... 40
4 Dell Lifecycle Controller Web Services Interface Guide for Windows
5.5.1 Modify User Name (Using DMTF Model) ................................................................................................................. 40
5.5.2 Modify Password (Using DMTF Model) ..................................................................................................................... 43
5.5.3 Modify Account State (Using DMTF Model) ............................................................................................................. 44
5.5.4 Modify User Privilege (Using DMTF Model) .............................................................................................................. 45
6 Firmware Inventory ................................................................................................................................................................. 47
6.1 Software Inventory Profile Specification ................................................................................................................... 47
6.2 Remote Inventory Method Invocation — Get Software Inventory ...................................................................... 47
7 Firmware Update ..................................................................................................................................................................... 49
7.1 Software Update Profile Specification....................................................................................................................... 49
7.2 ”Rollback” Firmware ...................................................................................................................................................... 49
7.2.1 Request “Rollback” Image ............................................................................................................................................ 49
7.2.2 Create Reboot Job ....................................................................................................................................................... 49
7.2.3 Schedule Update Jobs ................................................................................................................................................. 49
7.2.4 Monitor Update Jobs .................................................................................................................................................... 49
7.3 BIOS Firmware “Rollback” ............................................................................................................................................ 51
7.4 NIC Firmware “Rollback” .............................................................................................................................................. 52
7.5 Update from Network Source .................................................................................................................................... 54
7.5.1 Request Update Download ......................................................................................................................................... 54
7.5.2 Monitor Download Status ............................................................................................................................................ 54
7.5.3 Reboot to Perform Update .......................................................................................................................................... 54
7.5.4 Wait for Job Completion ............................................................................................................................................. 54
7.5.5 Delete Job ...................................................................................................................................................................... 54
7.6 Update NICs from HTTP, CIFS Share, NFS Share, TFTP, or FTP ........................................................................... 54
7.7 Update BIOS from HTTP, CIFS Share, NFS Share, TFTP, or FTP ........................................................................... 57
7.8 CreateRebootJob() ....................................................................................................................................................... 59
7.9 Automatic Updates ....................................................................................................................................................... 61
7.9.1 Enable Automatic Update ............................................................................................................................................ 61
7.9.2 Create a Config Job ..................................................................................................................................................... 61
7.9.3 Set Update Schedule .................................................................................................................................................... 62
7.9.4 Get the Update Schedule ............................................................................................................................................ 63
7.9.5 Clear the Update Schedule ......................................................................................................................................... 63
7.10 Device Update from Repository ................................................................................................................................. 64
5 Dell Lifecycle Controller Web Services Interface Guide for Windows
7.10.1 Install from Repository ................................................................................................................................................. 64
7.10.2 Get Repo-Based Update List ....................................................................................................................................... 65
8 Power State Management ...................................................................................................................................................... 69
8.1 Description of Base Server Versus Power State Management Methods ............................................................. 69
8.2 Get Power State ............................................................................................................................................................ 69
8.2.1 Base Server Method ...................................................................................................................................................... 69
8.2.2 Power State Management Method ............................................................................................................................ 70
8.3 Get Power Control Capabilites ................................................................................................................................... 71
8.3.1 Base Server Method ...................................................................................................................................................... 71
8.3.2 Power State Management Method ............................................................................................................................ 73
8.4 Power Control ............................................................................................................................................................... 75
8.4.1 Base Server Method ...................................................................................................................................................... 75
8.4.2 Power State Management Method ............................................................................................................................ 76
9 Hardware Inventory ................................................................................................................................................................. 77
9.1 Power Supply Inventory ............................................................................................................................................... 77
9.2 Fan Inventory ................................................................................................................................................................. 78
9.3 Memory Inventory ........................................................................................................................................................ 80
9.4 CPU Inventory................................................................................................................................................................ 82
9.5 iDRAC Card Inventory .................................................................................................................................................. 84
9.6 PCI Device Inventory .................................................................................................................................................... 85
9.7 Video Inventory ............................................................................................................................................................. 87
9.8 VFlash SD Card Inventory ............................................................................................................................................ 88
9.9 NIC Inventory and Configuration ............................................................................................................................... 89
9.10 RAID Inventory and Configuration ............................................................................................................................. 91
9.11 BIOS Inventory and Configuration ............................................................................................................................. 93
9.12 System Inventory (Including CSIOR Attribute) ......................................................................................................... 95
10 Job Control Management ...................................................................................................................................................... 98
10.1 Description of Job Management ............................................................................................................................... 98
10.2 Remote Job Control Examples .................................................................................................................................. 98
10.2.1 Setup Job Queue .......................................................................................................................................................... 98
10.2.2 Delete Job Queue ..................................................................................................................................................100
10.2.3 List Jobs in Job Store ............................................................................................................................................ 101
6 Dell Lifecycle Controller Web Services Interface Guide for Windows
11 Operating System Deployment ........................................................................................................................................... 104
11.1 OS Deployment Profile Implementation Conformance ...................................................................................... 104
11.2 Checking OS Deployment Service Availability ....................................................................................................... 104
11.3 OS Deployment Method Invocation Examples ..................................................................................................... 105
11.3.1 Get Driver Pack Information ..................................................................................................................................... 105
11.3.2 Unpack Selected Drivers and Attach to Host OS as USB Device ....................................................................... 106
11.3.3 Detach Emulated USB Device Containing Drivers ................................................................................................ 107
11.3.4 Unpack Selected Drivers and Copy to Network Share ........................................................................................ 107
11.3.5 Check Job Status ........................................................................................................................................................ 109
11.3.6 Boot to Network ISO .................................................................................................................................................. 110
11.3.7 Detach Network ISO USB Device .............................................................................................................................. 111
11.3.8 Boot To PXE ................................................................................................................................................................. 112
11.3.9 Get Host MAC Address Information ........................................................................................................................ 112
11.3.10 Download ISO to VFlash ................................................................................................................................... 113
11.3.11 Boot to ISO from VFlash ................................................................................................................................... 114
11.3.12 Delete ISO from VFlash ..................................................................................................................................... 115
11.3.13 Detach ISO from VFlash ................................................................................................................................... 115
11.3.14 Connect Network ISO Image .......................................................................................................................... 116
11.3.15 Disconnect Network ISO Image ...................................................................................................................... 117
11.3.16 Skip ISO Image Boot .......................................................................................................................................... 118
11.3.17 Get Network ISO Image Connection Information ....................................................................................... 119
11.3.18 Connect RFS ISO Image ................................................................................................................................... 119
11.3.19 Disconnect RFS ISO Image .............................................................................................................................. 120
11.3.20 Get RFS ISO Image Connection Information ............................................................................................... 121
11.3.21 Boot To Hard Disk Drive (HDD) ....................................................................................................................... 122
11.3.22 Configurable Boot to Network ISO ................................................................................................................ 122
12 Lifecycle Controller Management Profile ......................................................................................................................... 124
12.1 Collect System Inventory on Restart (CSIOR) ........................................................................................................ 124
12.2 Part Replacement Configuration and Management ............................................................................................. 126
12.2.1 Create Config Job ...................................................................................................................................................... 126
12.2.2 Get LC Config Job Status .......................................................................................................................................... 127
12.2.3 List All LC Jobs ............................................................................................................................................................. 127
7 Dell Lifecycle Controller Web Services Interface Guide for Windows
12.2.4 Get CSIOR Component Configuration Recovery (CCR) Attribute ..................................................................... 128
12.2.5 Get Part Firmware Update Attribute ........................................................................................................................ 129
12.3 Re-Initiate Auto-Discovery Client ............................................................................................................................ 130
12.4 Clear or Set Provisioning Server ............................................................................................................................... 131
12.5 Check vFlash License Enablement........................................................................................................................... 132
12.6 Download Server Public Key ..................................................................................................................................... 133
12.7 Download Client Certificates .................................................................................................................................... 134
12.8 Delete Auto-Discovery Client Certificates ............................................................................................................. 136
12.9 Set Public Certificates ................................................................................................................................................ 136
12.10 Set iDRAC Certificate and Private Key ..................................................................................................................... 138
12.11 Delete Auto-Discovery Server Public Key .............................................................................................................. 139
12.12 Insert Comment in Lifecycle Controller Log ......................................................................................................... 139
12.13 Export Lifecycle Controller Log ................................................................................................................................ 140
12.14 ExportCompleteLCLog() ............................................................................................................................................ 141
12.15 Export Hardware Inventory from Lifecycle Controller ......................................................................................... 143
12.16 Export Factory Configuration ................................................................................................................................... 144
12.17 System Decommission .............................................................................................................................................. 146
12.18 Get Remote Services API Status ............................................................................................................................... 146
12.19 Export System Configuration .................................................................................................................................... 147
12.20 Import System Configuration ................................................................................................................................... 148
12.21 XML Template Preview ............................................................................................................................................... 149
12.22 Remote Diagnostics ................................................................................................................................................... 151
12.22.1 Run Diagnostics ................................................................................................................................................. 151
12.22.2 Export Diagnostics Results ............................................................................................................................... 151
12.22.3 Verify the Diagnostics Job Status: .................................................................................................................. 152
13 VFlash SD Card Management .............................................................................................................................................. 154
13.1 Listing the SD Card Partitions ................................................................................................................................... 154
13.2 Initialize the Virtual Flash Media ............................................................................................................................... 155
13.2.1 Get vFlash SD Card Inventory ................................................................................................................................... 155
13.2.2 Initialize or Format Media .......................................................................................................................................... 156
13.2.3 Verify Initialization or Formatting ............................................................................................................................. 157
13.3 Enable or Disable vFlash using vFlash State Change ............................................................................................ 158
8 Dell Lifecycle Controller Web Services Interface Guide for Windows
13.4 Create Partition ........................................................................................................................................................... 158
13.5 Create Partition using Image .................................................................................................................................... 160
13.6 Delete Partition ............................................................................................................................................................ 162
13.7 Format Partition ........................................................................................................................................................... 163
13.8 Modify Partition ........................................................................................................................................................... 164
13.9 Attach Partition ............................................................................................................................................................ 165
13.10 Detach Partition........................................................................................................................................................... 166
13.11 Export Data from Partition ........................................................................................................................................ 168
14 Boot Control Configuration Management ......................................................................................................................... 171
14.1 Listing the Boot Inventory-ConfigSetting Class ..................................................................................................... 171
14.2 Getting a Boot ConfigSetting Instance ................................................................................................................... 172
14.3 Listing the Boot Inventory-SourceSetting Class ................................................................................................... 173
14.4 Changing the Boot Order by InstanceID-ChangeBootOrderByInstanceID() .................................................. 174
14.5 Enable or Disable the Boot Source-ChangeBootSourceState() ......................................................................... 175
15 NIC or CNA Card Management .......................................................................................................................................... 177
15.1 Listing the NIC or CNA Inventory-Enumeration Class ......................................................................................... 177
15.2 Listing the NIC or CNA Inventory-String Class ...................................................................................................... 179
15.3 Listing the CNA Inventory-Integer Class ................................................................................................................ 182
15.4 Listing the CNA Inventory-NICView Class ............................................................................................................. 184
15.5 Listing the CNA Inventory-NICCapabilities Class.................................................................................................. 187
15.6 Listing the CNA Inventory- NICStatistics Class ..................................................................................................... 189
15.7 Applying the Pending Values for CNA-CreateTargetedConfigJob() ................................................................. 191
15.8 Deleting the Pending Values for CNA-DeletePendingConfiguration() ............................................................. 192
15.9 Getting the CNA Enumeration Instance ................................................................................................................. 193
15.10 Setting the IscsiOffloadMode Attribute ................................................................................................................... 194
15.11 Setting the MaxBandwidth Attribute ........................................................................................................................ 195
15.12 Setting the VirtMacAddr Attribute ............................................................................................................................ 196
15.13 Setting the LegacyBootProto Attribute ................................................................................................................... 197
15.14 Setting CNA LAN Modes ............................................................................................................................................ 199
15.15 Setting the iSCSI Boot Target................................................................................................................................... 200
15.16 Setting the FCoE Boot Target ................................................................................................................................... 201
16 RAID Storage Management ................................................................................................................................................. 203
9 Dell Lifecycle Controller Web Services Interface Guide for Windows
16.1 Listing the RAID Inventory-Enumeration Class .................................................................................................... 203
16.2 Getting a RAID Enumeration Instance ................................................................................................................... 205
16.3 Listing the RAID Inventory-Integer Class ............................................................................................................... 206
16.4 Getting a RAID Integer Instance .............................................................................................................................. 208
16.5 Listing the RAID Inventory-String Class ................................................................................................................. 208
16.6 Getting a RAID String Instance ................................................................................................................................. 210
16.7 Listing the RAID Inventory-ControllerView Class ................................................................................................. 210
16.8 Getting a RAID ControllerView Instance................................................................................................................. 212
16.9 Listing the RAID Inventory-PhysicalDiskView Class .............................................................................................. 213
16.10 Listing the RAID VirtualDiskView Inventory ............................................................................................................ 216
16.11 Listing the RAID EnclosureView Inventory ............................................................................................................. 219
16.12 Reset Configuration-ResetConfig() ........................................................................................................................ 220
16.13 Clearing the Foreign Configuration-ClearForeignConfig() ................................................................................ 220
16.14 Applying the Pending Values for RAID-CreateTargetedConfigJob() ................................................................. 221
16.15 Deleting the Pending Values for RAID-DeletePendingConfiguration() ............................................................. 223
16.16 Managing Hot Spare .................................................................................................................................................. 224
16.16.1 Determining Potential Disks-GetDHSDisks() ............................................................................................... 224
16.16.2 Assigning the Hot Spare-AssignSpare() .......................................................................................................... 225
16.16.3 Unassigning the Hot Spare-UnassignSpare() ............................................................................................... 226
16.17 Managing Keys for Self Encrypting Drives ............................................................................................................. 226
16.17.1 Setting the Key-SetControllerKey() ................................................................................................................. 227
16.17.2 Locking the Virtual Disk-LockVirtualDisk() ................................................................................................... 228
16.17.3 Locking the Controller with a Key-EnableControllerEncryption() ........................................................... 228
16.17.4 Rekeying the Controller-ReKey() ................................................................................................................... 230
16.17.5 Removing the Key-RemoveControllerKey() .................................................................................................. 231
16.18 Managing Virtual Disk ................................................................................................................................................. 232
16.18.1 Getting the Available RAID levels-GetRAIDLevels() ..................................................................................... 232
16.18.2 Getting the Available Disks-GetAvailableDisks() .......................................................................................... 234
16.18.3 Checking the Create VD Parameters Validity-CheckVDValues() .............................................................. 235
16.18.4 Creating a Single Virtual Disk-CreateVirtualDisk() ...................................................................................... 236
16.18.5 Creating a Sliced Virtual Disk-CreateVirtualDisk() ........................................................................................239
16.18.6 Creating a Cachecade Virtual Disk-CreateVirtualDisk() ............................................................................. 242
10 Dell Lifecycle Controller Web Services Interface Guide for Windows
16.18.7 Deleting a Virtual Disk-DeleteVirtualDisk() ................................................................................................... 243
16.19 Setting Controller Attributes .................................................................................................................................... 244
16.19.1 Changing the Value of a RAID Controller Enumeration Attribute ........................................................... 244
16.19.2 Changing Multiple Values of RAID Controller Enumeration Attributes....................................................245
16.19.3 Changing the Value of a RAID Controller Integer Attribute ...................................................................... 246
16.19.4 Changing Multiple Values of RAID Controller Integer Attributes .............................................................. 247
16.20 Convert Physical Disks to RAID-ConvertToRAID() ............................................................................................... 248
16.21 Convert Physical Disks to Non RAID-ConvertToNonRAID() .............................................................................. 249
17 Managing BIOS Configuration............................................................................................................................................. 251
17.1 Listing the BIOS Inventory-Enumeration Class ..................................................................................................... 251
17.2 Getting a BIOS Enumeration Instance .................................................................................................................... 253
17.3 Changing the BIOS BootMode-SetAttribute()........................................................................................................ 253
17.4 Setting Multiple BIOS BootMode Parameters ........................................................................................................254
17.5 Listing the BIOS Inventory-Integer Class ................................................................................................................ 255
17.6 Listing the BIOS Inventory-String Class ..................................................................................................................256
17.7 Applying the Pending Values for BIOS & Boot-CreateTargetedConfigJob() ................................................... 257
17.8 Deleting the Pending Values for BIOS & Boot-DeletePendingConfiguration() ...............................................259
17.9 Managing BIOS Passwords ....................................................................................................................................... 260
17.9.1 Setting the BIOS Password ....................................................................................................................................... 260
17.9.2 Create Target Configuration Job ............................................................................................................................. 261
17.9.3 Monitor Set BIOS Password Status ......................................................................................................................... 262
17.10 Listing the BIOS Inventory-Password Class .......................................................................................................... 262
18 Exporting and Importing Server Profile .............................................................................................................................265
18.1 Exporting Server Profile .............................................................................................................................................265
18.1.1 Exporting Server Profile to iDRAC vFlash Card-BackupImage() .........................................................................265
18.1.2 Exporting Server Profile to NFS Share-BackupImage() ....................................................................................... 266
18.1.3 Exporting Server Profile to CIFS Share-BackupImage() ...................................................................................... 266
18.1.4 Monitoring Export status ........................................................................................................................................... 267
18.2 Automatic Backup ...................................................................................................................................................... 268
18.2.1 Enable the Automatic Backup ................................................................................................................................. 268
18.2.2 Set Backup Schedule ................................................................................................................................................. 269
18.2.3 Get the Backup Schedule ......................................................................................................................................... 269
11 Dell Lifecycle Controller Web Services Interface Guide for Windows
18.2.4 Clear the Backup Schedule ..................................................................................................................................270
18.3 Importing Server Profile .............................................................................................................................................270
18.3.1 Importing Server Profile from iDRAC vFlash Card-RestoreImage() ...................................................................270
18.3.2 Importing Server Profile from NFS share-RestoreImage() ................................................................................... 271
18.3.3 Importing Server Profile from CIFS share-RestoreImage() .................................................................................. 271
18.3.4 Monitoring Import Status ...................................................................................................................................... 272
19 iDRAC Configuration ............................................................................................................................................................. 274
19.1 Listing the iDRAC Card Inventory-Enumeration Class ......................................................................................... 274
19.2 Getting an iDRAC Card Enumeration Instance ...................................................................................................... 276
19.3 Listing the iDRAC Card Inventory-Enumeration Class using groupID .............................................................. 277
19.4 Applying the Attributes and Polling Job Completion .......................................................................................... 280
19.4.1 Changing iDRAC Values-ApplyAttributes() (Immediate) ..................................................................................... 280
19.4.2 Polling Job Completion ....................................................................................................................................... 282
19.4.3 Set Attribute Verification ...................................................................................................................................... 282
19.5 Listing the iDRAC Card Inventory-Integer Class .................................................................................................. 285
19.6 Listing the iDRAC Card Inventory-Integer Class using groupID........................................................................ 286
19.7 Listing the iDRAC Card Inventory-String Class ..................................................................................................... 288
19.8 Listing the iDRAC Card Inventory-String Class using groupID .......................................................................... 289
19.9 Changing the iDRAC IP Change Notification........................................................................................................ 292
19.9.1 Getting the Current iDRAC IPChange State .......................................................................................................... 292
19.9.2 Setting the iDRAC IPChange Notification-SetAttribute() ............................................................................... 292
20 Remote Service Status ......................................................................................................................................................... 294
20.1 Getting Remote Service Status ................................................................................................................................ 294
20.2 Restarting Remote Service Status ........................................................................................................................... 296
21 System Information .............................................................................................................................................................. 298
21.1 Listing the System Inventory-SystemView Class .................................................................................................. 298
22 Sensor Information ................................................................................................................................................................ 301
22.1 Listing the Sensors Inventory-PSNumericSensor Class ....................................................................................... 301
23 Managing Fiber Channel (FC) Configuration ................................................................................................................... 305
23.1 Listing the FC Inventory-Attribute Class ................................................................................................................ 305
23.2 Listing the FC Inventory-Statistics Class ................................................................................................................ 306
23.3 Listing the FC Inventory-String Class ..................................................................................................................... 308
12 Dell Lifecycle Controller Web Services Interface Guide for Windows
23.4 Listing the FC Inventory-Integer Class ................................................................................................................... 309
23.5 Listing the FC Inventory-Enumeration Class ........................................................................................................ 309
23.6 Changing the FC Attributes-SetAttribute() ............................................................................................................. 310
23.7 Applying the Pending Values for FC-CreateTargetedConfigJob() ..................................................................... 311
23.8 Deleting the Pending Values for FC-DeletePendingConfiguration() ................................................................. 313
23.9 Listing the FC Views .................................................................................................................................................... 314
13 Dell Lifecycle Controller Web Services Interface Guide for Windows
Executive Summary
Dell PowerEdge servers are equipped with the integrated Dell Remote Access Controller and the
Lifecycle Controller solution for remote management―iDRAC6 on 11th generation servers and iDRAC7
on 12th generation servers. These servers can be remotely managed by using the WS-Man services for
configuration, update, deployment, and maintenance. This whitepaper describes the various WS-Man
interfaces with examples about using different interfaces in a Windows environment.
14 Dell Lifecycle Controller Web Services Interface Guide for Windows
1 Introduction
This document serves as a guideline for utilizing the functionality available from embedded Lifecycle
Controller Remote Enablement Web Services interfaces. The purpose of this document is to provide
information and examples for utilizing the Web services for Management (WS-Man) management protocol
using Windows WinRM and open source WSMANCLI command line utilities. Examples and invocation
information is provided for the following functionality.
Inventory for BIOS, component firmware and embedded software
Update of BIOS, component firmware and embedded software
Job Control of update tasks
Enhancement of Operating System Deployment using VFlash SD Card
Enhancement of Discovery and Handshake from LifeCycle Controller 1.x
RAID configuration management
iDRAC Inventory and configuration features
NIC configuration management
Boot configuration management
BIOS configuration management
The target audience for this document is application and script writers who want to utilize the remote
management capabilities using WS-Man protocol available from Dell Lifecycle Controller.
15 Dell Lifecycle Controller Web Services Interface Guide for Windows
2 References
Dell 12th generation PowerEdge server resources:
http://www.delltechcenter.com/12thGen
Dell CIM Profiles:
http://www.delltechcenter.com/page/DCIM.Library.Profile
Managed Object Format (MOF) files:
http://www.delltechcenter.com/page/DCIM.Library.MOF
WinRM Scripting API, MSDN:
http://msdn.microsoft.com/en-us/library/aa384469(VS.85).aspx
Openwsman CLI:
http://www.openwsman.org/project/wsmancli
DMTF Common Information Model (CIM) Infrastructure Specification (DSP0004):
http://www.dmtf.org/standards/published_documents/DSP0004_2.5.0.pdf
List of PCI IDs:
http://pciids.sourceforge.net/pci.ids
16 Dell Lifecycle Controller Web Services Interface Guide for Windows
3 Overview
The remote interface guidelines provided in this document are illustrated by command line interface (CLI)
examples of the WS-Man protocol Web services APIs that expose the remote management capabilities of
the Dell Lifecycle Controller. The command line examples are from the Microsoft® Windows® and Linux
environments using WinRM
management capabilities are organized by management domain and documented in Dell CIM Profile
specifications
capabilities:
Remotely get inventory of the BIOS, component firmware, and embedded software including
version information of both the installed as well as available cached versions
Remote update of BIOS, component firmware, Diagnostic content, DRAC content, driver pack,
power supplies from remotely located Dell Update Packages or cached images located in the
Lifecycle Controller
Remotely schedule and track the status of update tasks (jobs)
Remotely manage the Part Replacement feature by allowing retrieving and setting auto update and
auto system inventory sync
Enable re-initiation of Lifecycle Controller Auto-Discovery feature
Enhancement of Operation System Deployment capabilities by supporting the downloading of an
ISO image to a Dell VFlash SD Card and booting to the ISO image on the VFlash SD Card
NIC configuration enables the ability to get and set NIC attributes that are configurable using NIC
Option ROM or NIC UEFI HII.
Remote RAID configuration allows users to remotely query and configure the Hardware Raid of the
system
Multiple HW Inventory views allows users to remote query the inventory of Hardware
2
.. The remote enablement feature for Lifecycle Controller 2.0 provides the following
4
and WSMANCLI
5
respectively. The Lifecycle Controller remote
3.1 Format for WinRM CLI Examples in Document
The examples of WinRM and WSMANCLI command line invocations in this document are formatted for
readability and often span multiple lines in the document. In actual use, scripted or hand-typed
invocations are contained on one line. The examples also use substitute values for the target iDRAC IP
address, username (with ExecuteServerCommand privilege), password and other site specific information.
Actual use of these examples would require using values for IP Address, username and password, etc. that
are valid. These values are represented in the examples as follows:
Target iDRAC IP address = [IPADDRESS]
iDRAC Username = [USER]
iDRAC Password = [PASSWORD]
Additional substitute values are used in some of the examples and are described in the specific example.
The following example is typical of the formatting used in this document:
17 Dell Lifecycle Controller Web Services Interface Guide for Windows
EXAMPLE:
winrm e cimv2/root/dcim/DCIM_OSDeploymentService
-u:[USER] -p:[PASSWORD]
-r:https://[IPADDRESS]/wsman:443
-encoding:utf-8 -a:basic
3.2 WS-Man Security and Time Parameters
3.2.1 Encryption Certificate Security
For the WinRM examples provided in this document, the strict checks of certificates such as matching of
CNs (Common Names) and verification with the actual CA (Certificate Authority) of the certificate of the
WS-Management protocol HTTPS encryption certificate is assumed to be already configured and enabled.
To disable the strict certificate checking, add the following command line options to all WinRM examples:
–skipCACheck and -skipCNCHeck.
Additionally, the following error may result if the end point does not support this feature. Use the switch skiprevocationcheck to bypass this error.
WSManFault
Message = The server certificate on the destination computer (10.35.0.232:443) has the following errors:
The SSL certificate could not be checked for revocation. The server used to check for revocation might be
unreachable.
Refer to the WinRM documentation 4 and related documentation for directions on setting up encryption
certificates for WinRM and executing WinRM invocations using full security capabilities. Refer to the
Lifecycle Controller User Guide 1 for directions on configuring different encryption certificates for the
iDRAC Web server. Dell recommends that the full security and encryption capabilities of the WSManagement protocol is used for production level utilization of the Lifecycle Controller Web services
interfaces.
3.2.2 Handling Invalid Responses from WS-Man Commands
Check the network connection to make sure that the system is connected
Check the WS-Man syntax to ensure there are no typos in the command line
Check if there are other WS-Man commands sending from other systems
Wait for a few seconds and re-try the WSMAN command
18 Dell Lifecycle Controller Web Services Interface Guide for Windows
3.2.3 Improving WinRM Enumeration Performance
When an enumeration command is executed, the default WinRM configuration gets only 20 instances at a
time and therefore slows down the system drastically. Changing the WinRM configuration to allow a
greater number, such as 50, will reduce the time taken by the enumeration operations.
Execute the following command to get instances in groups of up to 50.
winrm set winrm/config @{MaxBatchItems="50"}
Additionally, increasing the allotted maximum envelope size and timeout can also increase performance.
winrm set winrm/config @{MaxEnvelopeSizekb="150"}
winrm set winrm/config @{MaxTimeoutms ="60000"}
Other optional WinRM configuration commands are listed below for convenience. To get the current
WinRM configuration settings, execute the following command.
winrm g winrm/config
By default, the client computer requires encrypted network traffic. To allow the client computer to request
unencrypted traffic, execute the following command:
winrm s winrm/config/Client @{AllowUnencrypted="true"}
TrustedHosts is an array that specifies the list of remote computers that are trusted. Other computers in a
workgroup or computers in a different domain should be added to this list.
Note: The computers in the TrustedHosts list are not authenticated.
Execute the following command to allow all computers to be included in TrustedHosts.
winrm s winrm/config/Client @{TrustedHosts="*"}
Basic authentication is a scheme in which the user name and password are sent in clear text to the server
or proxy. This method is the least secure method of authentication. The default is True.
Execute the following command to set client computer to use Basic authentication.
winrm s winrm/config/Client/Auth @{Basic="true"}
3.2.4 Specifying StartTime, Until Time, and TIME_NOW Parameters
The several methods that attach a virtual USB device to the target system accept a StartTime and Until
parameter. The parameter data type is CIM date-time. If the StartTime parameter is null the action will not
be started. If the Until parameter is null, the default value will be 17 hours. The date-time data type is
defined in the CIM Infrastructure Specification 4 as:
19 Dell Lifecycle Controller Web Services Interface Guide for Windows
Term
Meaning
BIOS
Basic Input / Output System
HW
Hardware
iDRAC
Integrated DELL Remote Access Controller
IPL
Initial Program Load
DUP
Dell Update Package
MOF
Managed Object File
CIM
Common Information Model
NIC
Network Interface Controller
RAID
Redundant Array of Independent Disks
FQDD
Fully Qualified Device Description
ddddddddhhmmss.mmmmmm
Where:
dddddddd is the number of days
hh is the remaining number of hours
mm is the remaining number of minutes
ss is the remaining number of seconds
mmmmmm is the remaining number of microseconds
The Lifecycle controller firmware update, and set attribute related methods that require a date time
parameter, use the form YYYYMMDDhhmmss (Eg. 20090930112030). The user is expected to enter the
date and time in this format for all Lifecycle Controller updates and set attribute tasks. TIME_NOW is a
special value that represents “running the tasks immediately”.
3.2.5 Return Values
Many of the methods in this document have the following possible return values. They are summarized
here for convenience.
0 = Success
1 = Not Supported
2 = Failed
4096 = Job Created
3.2.6 Glossary
20 Dell Lifecycle Controller Web Services Interface Guide for Windows
UEFI
Unified Extensible Firmware Interface
AMEA
Advanced Management Enablement
Adapter
HII
Human Interface Infrastructure
WS-Man
WS-Management is a specification of a
SOAP-based protocol for the management
of servers, devices, applications and more
21 Dell Lifecycle Controller Web Services Interface Guide for Windows
4 Discovery
4.1 Discovering Web Service Capability
Determine if the target system supports the WinRM interface using the ‘identify’ command.
Profiles: http://www.dmtf.org/sites/default/files/standards/documents/DSP0217_2.0.0.pdf
EXAMPLE:
winrm identify
-u:[USER] -p:[PASSWORD]
-r:https://[IPADDRESS]/wsman
-SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic
OUTPUT:
IdentifyResponse
ProtocolVersion = http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd
ProductVendor = Openwsman Project
ProductVersion = 2.2.4
4.2 Discovering the Implemented Profiles
Implemented profiles are advertised using the class CIM_RegisteredProfile. Enumerate this class in the
“root/interop” CIM namespace.
Profiles: http://www.dmtf.org/sites/default/files/standards/documents/DSP1033_1.0.0.pdf
EXAMPLE:
winrm e http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/CIM_RegisteredProfile?__cimnamespace=root/interop -u:[USER] -p:[PASSWORD] r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic
OUTPUT:
DCIM_LCRegisteredProfile
AdvertiseTypeDescriptions = WS-Identify, Interop Namespace AdvertiseTypes = 1, 1
InstanceID = DCIM:Memory:1.0.0
22 Dell Lifecycle Controller Web Services Interface Guide for Windows
OtherRegisteredOrganization = DCIM
RegisteredName = Memory
RegisteredOrganization = 1
RegisteredVersion = 1.0.0
...
DCIM_RegisteredProfile
AdvertiseTypeDescriptions = WS-Identify
AdvertiseTypes = 1
Caption = null
Description = null
ElementName = null
InstanceID = DCIM:CSRegisteredProfile:1 OtherRegisteredOrganization = null
RegisteredName = Base Server
RegisteredOrganization = 2
RegisteredVersion = 1.0.0
.
.
The above example shows that the DMTF Base Server profile version 1.0.0 is implemented.
4.3 Discovering Implementation Namespace
The implementation CIM namespace may be discovered from the interop (root/interop) CIM namespace
using the class CIM_ElementConformsToProfile that associates an instance of CIM_RegisteredProfile class
with an instance of CIM_ComputerSystem class.
Profiles: n/a
EXAMPLE:
winrm e http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/* -dialect:association
-associations - filter:
{object=DCIM_ComputerSystem?CreationClassName=DCIM_ComputerSystem+Name=srv:syste
m+__cimna mespace=root/dcim}
23 Dell Lifecycle Controller Web Services Interface Guide for Windows
-u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -encoding:utf-8 -a:basic SkipCNcheck –SkipCAcheck
OUTPUT:
DCIM_CSRoleLimitedToTarget
DefiningRole
Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous
ReferenceParameters
ResourceURI = http://schemas.dell.com/wbem/wscim/1/cim-schema/2/DCIM_Role
SelectorSet
Selector: CreationClassName = DCIM_Role, Name = DCIM:Role:9, __cimnamespace = root/dcim
TargetElement
Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous
ReferenceParameters
ResourceURI = http://schemas.dell.com/wbem/wscim/1/cim- schema/2/DCIM_ComputerSystem
SelectorSet
Selector: CreationClassName = DCIM_ComputerSystem, Name = srv:system, __cimnamespace =
root/dcim
DCIM_CSRoleLimitedToTarget
DefiningRole
Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous
ReferenceParameters
ResourceURI = http://schemas.dell.com/wbem/wscim/1/cim-schema/2/DCIM_Role SelectorSet
Selector: CreationClassName = DCIM_Role, Name = DCIM:R ole:10, __cimnamespace = root/dcim
TargetElement
Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous
ReferenceParameters
24 Dell Lifecycle Controller Web Services Interface Guide for Windows
ResourceURI = http://schemas.dell.com/wbem/wscim/1/cim- schema/2/DCIM_ComputerSystem
SelectorSet
Selector: CreationClassName = DCIM_ComputerSystem, Name = srv:system, __cimnamespace =
root/dcim
25 Dell Lifecycle Controller Web Services Interface Guide for Windows
5 Managing iDRAC Local User Accounts
5.1 Description of iDRAC Attributes Versus Standard DMTF Model
The iDRAC user account management data model is represented by both DMTF and Dell Profiles. Both
models are currently offered. The DMTF Profiles for Simple Identity Management and Role Based
Authorization represent iDRAC user accounts and privileges. The DMTF data model is complex and
typically requires multiple transactions to accomplish simple operations such as specifying a username
and password or giving a user account admin privileges. For this reason, LC also offers a Dell data model
for managing iDRAC user accounts that is based on an attribute model. The DCIM iDRAC Card Profile
specifies the attributes for each user account name, password, and privilege. The iDRAC has 15 local user
account that can be managed.
5.2 Account Inventory (Using iDRAC Attributes)
The list of user accounts may be retrieved by enumerating the DCIM_iDRACCard classes. The class
provides the user account name and enabled state properties.
Profile and Associated MOFs:
http://www.delltechcenter.com/page/DCIM.Library.Profile
5.2.1 Account and Capabilities (Using iDRAC Attributes)
Enumerating the DCIM_iDRACCardEnumeration class, Section 19.1, and parsing the output for the
attribute AttributeDisplayName = User Admin Enable, will display all of the 16 possible user accounts and
their respective status.
EXAMPLE:
winrm e http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_iDRACCardEnumeration -u:[USER] -p:[PASSWORD]
-r:https://[IPADDRESS]/wsman:443 -SkipCNcheck -SkipCAcheck -encoding:utf-8 a:basic
OUTPUT:
DCIM_iDRACCardEnumeration
AttributeDisplayName = User Admin Enable
AttributeName = Enable
CurrentValue = Disabled
DefaultValue = Disabled
26 Dell Lifecycle Controller Web Services Interface Guide for Windows
Dependency = null
DisplayOrder = 0
FQDD = iDRAC.Embedded.1
GroupDisplayName = Users
GroupID = Users.1
InstanceID = iDRAC.Embedded.1#Users.1#Enable
IsReadOnly = true
PossibleValues = Disabled, Enabled
DCIM_iDRACCardEnumeration
AttributeDisplayName = User Admin Enable
AttributeName = Enable
CurrentValue = Enabled
DefaultValue = Enabled
Dependency = null
DisplayOrder = 0
FQDD = iDRAC.Embedded.1
GroupDisplayName = Users
GroupID = Users.2
InstanceID = iDRAC.Embedded.1#Users.2#Enable
IsReadOnly = false
PossibleValues = Disabled, Enabled
.
.
27 Dell Lifecycle Controller Web Services Interface Guide for Windows
5.2.2 Privilege and Capabilities (Using iDRAC Attributes)
Enumerating the DCIM_iDRACCardEnumeration class, Section 19.1, and parsing the output for the
attribute AttributeDisplayName = User Admin IPMI LAN(or Serial) Privilege, will display all of the 16 possible
user accounts and their respective status.
EXAMPLE:
DCIM_iDRACCardEnumeration
AttributeDisplayName = User Admin IPMI LAN Privilege
AttributeName = IpmiLanPrivilege
CurrentValue = NoAccess
DefaultValue = NoAccess
Dependency = null
DisplayOrder = 0
FQDD = iDRAC.Embedded.1
GroupDisplayName = Users
GroupID = Users.1
InstanceID = iDRAC.Embedded.1#Users.1#IpmiLanPrivilege
IsReadOnly = true
PossibleValues = User, Operator, Administrator, NoAccess
DCIM_iDRACCardEnumeration
AttributeDisplayName = User Admin IPMI Serial Privilege
AttributeName = IpmiSerialPrivilege
CurrentValue = NoAccess
DefaultValue = NoAccess
Dependency = null
DisplayOrder = 0
FQDD = iDRAC.Embedded.1
28 Dell Lifecycle Controller Web Services Interface Guide for Windows
GroupDisplayName = Users
GroupID = Users.1
InstanceID = iDRAC.Embedded.1#Users.1#IpmiSerialPrivilege
IsReadOnly = true
PossibleValues = User, Operator, Administrator, NoAccess.
.
5.3 Manage Account Settings (Using iDRAC Attributes)
When the account setting capability allows, the user name of an account may be modified by invoking the
ApplyAttributes() method on the UserName property. Confirmation of successful user name or password
verification can be obtained by enumerating the DCIM_iDRACCardString class( Section 19.6).
5.3.1 Modify User Name (Using iDRAC Attributes)
EXAMPLE:
winrm i ApplyAttributes http://schemas.dmtf.org/wbem/wscim/1/cimschema/
2/root/dcim/DCIM_iDRACCardService
?SystemCreationClassName=DCIM_ComputerSystem
+CreationClassName=DCIM_iDRACCardService
+SystemName=DCIM:ComputerSystem
+Name=DCIM:iDRACCardService
-u:[USER] -p:[PASSWORD]
-r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck
-encoding:utf-8 -a:basic -file: DracCard_UserName.xml
The input file, DracCard_UserName.xml, is shown below:
<p:ApplyAttributes_INPUT
xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cimschema/
2/root/dcim/DCIM_iDRACCardService">
<p:Target>iDRAC.Embedded.1</p:Target>
<p:AttributeName>Users.4#UserName</p:AttributeName>
29 Dell Lifecycle Controller Web Services Interface Guide for Windows
<p:AttributeValue>HELLO</p:AttributeValue>
</p:ApplyAttributes_INPUT>
OUTPUT:
When this method is executed, a jobid or an error message is returned.
ApplyAttributes_OUTPUT
ReturnValue = 4096
Job
EndpointReference
Address = https://127.0.0.1:443/wsman
ReferenceParameters
ResourceURI = http://schemas.dell.com/wbem/wscim/1/cim-
schema/2/DCIM_LifecycleJob
SelectorSet
Selector: __cimnamespace = root/dcim,
InstanceID = JID_001296571842
5.3.2 Modify Password (Using iDRAC Attributes)
EXAMPLE:
winrm i ApplyAttributes http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_iDRACCardService ?SystemCreationClassName=DCIM_ComputerSystem
+CreationClassName=DCIM_iDRACCardService +SystemName=DCIM:ComputerSystem
+Name=DCIM:iDRACCardService -u:[USER] -p:[PASSWORD]
-r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic file:DracCard_Password.xml
The input file, DracCard_Password.xml, is shown below:
<p:ApplyAttributes_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_iDRACCardService">
<p:Target>iDRAC.Embedded.1</p:Target> <p:AttributeName>Users.4#Enable</p:AttributeName>
<p:AttributeValue>Enabled</p:AttributeValue> <p:AttributeName>Users.4#Password</p:AttributeName>
<p:AttributeValue>PWORDHERE</p:AttributeValue>
30 Dell Lifecycle Controller Web Services Interface Guide for Windows
Loading...