Dell Lifecycle Controller 1.2, Lifecycle Controller 1.3, Lifecycle Controller 1.4, Lifecycle Controller 1.5 for Linux, Lifecycle Controller 1.5.5 for Linux Web Services Interface Guide

...
0 (0)
Dell Lifecycle Controller 1.2, Lifecycle Controller 1.3, Lifecycle Controller 1.4, Lifecycle Controller 1.5 for Linux, Lifecycle Controller 1.5.5 for Linux Web Services Interface Guide

Dell™ Lifecycle Controller 2 Web

Services Interface Guide for Linux

Document Status: Published

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

This document is for informational purposes only and may contain typographical errors and technical inaccuracies. The content is provided as is, without express or implied warranties of any kind.

© 2012 Dell Inc. All rights reserved. Dell and its affiliates cannot be responsible for errors or omissions in typography or photography. Dell, the Dell logo, and PowerEdge are trademarks of Dell Inc. Intel and Xeon are registered trademarks of Intel Corporation in the U.S. and other countries. Microsoft, Windows, and Windows Server are either trademarks or 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 proprietary interest in the marks and names of others.

December 2012| Rev 2.1.0

2

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux Version: 2.1.0

CONTENTS

1

Introduction

........................................................................................................................

10

2

References ........................................................................................................................

 

10

3

Overview............................................................................................................................

 

12

 

3.1

Format .......................................................for WSMAN CLI Examples in Document

12

 

3.2

WS-Man .......................................................................Security & Time Parameters

13

 

 

3.2.1 .......................................................................

Encryption Certificate Security

13

 

 

3.2.2 ...................................Handling invalid responses from WSMAN commands

13

 

 

3.2.3 ..............................................Improving WSMAN Enumeration Performance

13

 

 

3.2.4 ....................Specifying StartTime, Until Time, and TIME_NOW Parameters

13

 

 

3.2.5 ...............................................................................................

Return Values

14

 

 

3.2.6 ........................................................................................................

Glossary

14

4

Discovery ...........................................................................................................................

 

15

 

4.1

Discovering .........................................................................Web Service Capability

15

 

4.2

Discovering ..............................................................what Profiles are Implemented

15

 

4.3

Discovering ..................................................................Implementation Namespace

16

5 Managing iDRAC ..............................................................................Local User Accounts

17

 

5.1

Description .......................................of iDRAC Attributes vs Standard DMTF Model

17

 

5.2

Account ..............................................................Inventory (using iDRAC Attributes)

17

 

 

5.2.1 ........................................Account and Capabilities (using iDRAC Attributes)

18

 

 

5.2.2 .......................................Privilege and Capabilities (using iDRAC Attributes)

19

 

5.3

Manage ..................................................Account Settings (using iDRAC Attributes)

20

 

 

5.3.1 .................................................Modify User Name (using iDRAC Attributes)

20

 

 

5.3.2 ....................................................Modify Password (using iDRAC Attributes)

21

 

 

5.3.3 .............................................Modify Account State (using iDRAC Attributes)

22

 

 

5.3.4 .............................................Modify User Privilege (using iDRAC Attributes)

23

 

5.4

Account ....................................................................Inventory (using DMTF Model)

24

 

 

5.4.1 ..............................................Account and Capabilities (using DMTF Model)

24

 

 

5.4.2 .............................................Privilege and Capabilities (using DMTF Model)

29

 

5.5

Manage ........................................................Account Settings (using DMTF Model)

32

 

 

5.5.1 .......................................................Modify User Name (using DMTF Model)

32

 

 

5.5.2 ..........................................................Modify Password (using DMTF Model)

37

 

 

5.5.3 ...................................................Modify Account State (using DMTF Model)

37

 

 

5.5.4 ...................................................Modify User Privilege (using DMTF Model)

38

6

Firmware Inventory ............................................................................................................

39

 

6.1

Software ....................................................................Inventory Profile Specification

39

 

6.2

Remote ................................Inventory Method Invocation – Get Software Inventory

39

7

Firmware Update ...............................................................................................................

41

 

7.1

Software .......................................................................Update Profile Specification

41

 

7.2

”Rollback” ..................................................................................................Firmware

41

 

 

7.2.1 .............................................................................

Request “Rollback” Image

41

 

 

 

3

 

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux Version: 2.1.0

 

 

7.2.2

Create Reboot Job ........................................................................................

41

 

 

7.2.3

Schedule Update Jobs ..................................................................................

41

 

 

7.2.4

Monitor Update Jobs .....................................................................................

41

 

7.3

BIOS Firmware “Rollback” ........................................................................................

42

 

7.4

NIC Firmware “Rollback”...........................................................................................

44

 

7.5

Update from Network Source....................................................................................

45

 

 

7.5.1

Request Update Download............................................................................

46

 

 

7.5.2

Monitor Download Status ..............................................................................

46

 

 

7.5.3 Reboot to Perform Update.............................................................................

46

 

 

7.5.4 Wait for Job Completion ................................................................................

46

 

 

7.5.5

Delete Job .....................................................................................................

46

 

7.6

Update NICs from HTTP, CIFS Share, TFTP, or FTP ...............................................

46

 

7.7

Update BIOS from HTTP, CIFS Share, TFTP, or FTP ..............................................

48

 

7.8

CreateRebootJob() ...................................................................................................

50

8

Power State Management..................................................................................................

52

 

8.1

Description of Base Server vs Power State Management Methods...........................

52

 

8.2

Get Power State .......................................................................................................

52

 

 

8.2.1

Base Server Method......................................................................................

52

 

 

8.2.2 Power State Management Method ................................................................

53

 

8.3

Get Power Control Capabilites ..................................................................................

55

 

 

8.3.1

Base Server Method......................................................................................

55

 

 

8.3.2 Power State Management Method ................................................................

57

 

8.4

Power Control ...........................................................................................................

58

 

 

8.4.1

Base Server Method......................................................................................

58

 

 

8.4.2 Power State Management Method ................................................................

59

9

Hardware Inventory............................................................................................................

59

 

9.1

Power Supply Inventory ............................................................................................

59

 

9.2

Fan Inventory............................................................................................................

61

 

9.3

Memory Inventory .....................................................................................................

62

 

9.4

CPU Inventory ..........................................................................................................

63

 

9.5

iDRAC Card Inventory ..............................................................................................

65

 

9.6

PCI Device Inventory ................................................................................................

65

 

9.7

Video Inventory.........................................................................................................

66

 

9.8

VFlash SD Card Inventory ........................................................................................

67

 

9.9

NIC Inventory & Configuration ..................................................................................

68

 

9.10

RAID Inventory & Configuration ................................................................................

70

 

9.11

BIOS Inventory & Configuration ................................................................................

71

 

9.12

System Inventory (including CSIOR attribute) ...........................................................

72

10

Job Control Management ...................................................................................................

74

 

10.1

Description of Job Management ...............................................................................

74

 

10.2

Remote Job Control Examples .................................................................................

74

 

 

10.2.1 Setup Job Queue ..........................................................................................

74

 

 

 

4

 

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux Version: 2.1.0

 

10.2.2 Delete Job Queue .........................................................................................

76

 

10.2.3 List Jobs in Job Store ....................................................................................

77

11 Operating System Deployment ..........................................................................................

78

11.1

OS Deployment Profile Implementation Conformance ..............................................

79

11.2

Checking OS Deployment Service Availability ..........................................................

79

11.3

OS Deployment Method Invocation Examples ..........................................................

80

 

11.3.1 Get Driver Pack Information ..........................................................................

80

 

11.3.2 Unpack Selected Drivers and Attach to Host OS as USB Device ..................

82

 

11.3.3 Detach Emulated USB Device Containing Drivers.........................................

83

 

11.3.4 Unpack Selected Drivers and Copy to Network Share...................................

84

 

11.3.5 Check Job Status ..........................................................................................

85

 

11.3.6 Boot to Network ISO......................................................................................

87

 

11.3.7 Detach Network ISO USB Device..................................................................

88

 

11.3.8 Boot To PXE .................................................................................................

89

 

11.3.9 Get Host MAC Address Information ..............................................................

89

 

11.3.10 Download ISO to VFlash ...........................................................................

90

 

11.3.11 Boot to ISO from VFlash............................................................................

92

 

11.3.12 Delete ISO from VFlash.............................................................................

92

 

11.3.13 Detach ISO from VFlash............................................................................

93

 

11.3.14 Connect Network ISO Image .....................................................................

94

 

11.3.15 Disconnect Network ISO Image.................................................................

95

 

11.3.16 Skip ISO Image Boot .................................................................................

96

 

11.3.17 Get Network ISO Image Connection Information .......................................

96

 

11.3.18 Connect RFS ISO Image ...........................................................................

97

 

11.3.19 Disconnect RFS ISO Image.......................................................................

98

 

11.3.20 Get RFS ISO Image Connection Information .............................................

99

 

11.3.21 Boot To Hard Drive (HD) ...........................................................................

99

 

11.3.22 Configurarable Boot to Network ISO........................................................

100

12 Lifecycle Controller Management Profile ..........................................................................

101

12.1

Collect System Inventory on Restart (CSIOR).........................................................

101

12.2

Part Replacement Configuration and Management.................................................

103

 

12.2.1 Create Config Job .......................................................................................

103

 

12.2.2 Get LC Config Job Status............................................................................

104

 

12.2.3 List All LC Jobs ...........................................................................................

105

 

12.2.4 Get CSIOR Component Configuration Recovery (CCR) Attribute................

105

 

12.2.5 Get Part Firmware Update Attribute ............................................................

106

12.3

Re-Initiate Auto-Discovery Client ............................................................................

107

12.4

Clear or Set Provisioning Server .............................................................................

108

12.5

Check VFlash License Enablement ........................................................................

110

12.6

Download Server Public Key...................................................................................

110

12.7

Download Client Certificates ...................................................................................

111

12.8

Delete Auto-Discovery Client Certificates................................................................

113

 

5

 

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux Version: 2.1.0

12.9

Set Public Certificates.............................................................................................

113

12.10 Set iDRAC Certificate and Private Key....................................................................

114

12.11 Delete Auto-Discovery Server Public Key ...............................................................

115

12.12 Insert Comment in Lifecycle Controller Log.............................................................

116

12.13 Export Lifecycle Controller Log ...............................................................................

116

12.14 Export Hardware Inventory from Lifecycle Controller ..............................................

117

12.15 Export Factory Configuration ..................................................................................

119

12.16 System Decommission ...........................................................................................

120

12.17 Get Remote Services API Status ............................................................................

120

12.18 Export System Configuration ..................................................................................

121

12.19 Import System Configuration...................................................................................

122

13 VFlash SD Card Management .........................................................................................

124

13.1

Listing the SD Card Partitions .................................................................................

124

13.2

Initialize the Virtual Flash Media..............................................................................

125

 

13.2.1 Get VFlash SD Card Inventory ....................................................................

125

 

13.2.2 Initialize / Format Media ..............................................................................

126

 

13.2.3 Verify Initialization / Formatting....................................................................

127

13.3

Enable/Disable VFlash using VFlash State Change................................................

127

13.4

Create Partition.......................................................................................................

128

13.5

Create Partition using Image...................................................................................

129

13.6

Delete Partition .......................................................................................................

131

13.7

Format Partition ......................................................................................................

132

13.8

Modify Partition .......................................................................................................

134

13.9

Attach Partition .......................................................................................................

134

13.10 Detach Partition ......................................................................................................

135

13.11 Export Data from Partition.......................................................................................

137

14 Boot Control Configuration Management .........................................................................

138

14.1

Listing the Boot Inventory-ConfigSetting Class .......................................................

139

14.2

Getting a Boot ConfigSetting Instance ....................................................................

140

14.3

Listing the Boot Inventory-SourceSetting Class ......................................................

140

14.4

Changing the Boot Order by InstanceID-ChangeBootOrderByInstanceID() ............

141

14.5

Enable or Disable the Boot Source-ChangeBootSourceState()...............................

142

15 NIC/CNA Card Management............................................................................................

143

15.1

Listing the NIC/CNA Inventory-Enumeration Class .................................................

144

15.2

Listing the NIC/CNA Inventory-String Class ............................................................

145

15.3

Listing the CNA Inventory-Integer Class .................................................................

147

15.4

Listing the CNA Inventory-NICView Class...............................................................

148

15.5

Listing the CNA Inventory-NICCapabilities Class ....................................................

150

15.6

Listing the CNA InventoryNICStatistics Class .......................................................

151

15.7

Applying the Pending Values for CNA-CreateTargetedConfigJob().........................

152

15.8

Deleting the Pending Values for CNA-DeletePendingConfiguration()......................

153

15.9

Getting the CNA Enumeration Instance ..................................................................

154

 

6

 

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux Version: 2.1.0

15.10 Setting the IscsiOffloadMode Attribute ....................................................................

155

15.11 Setting the MaxBandwidth Attribute ........................................................................

156

15.12 Setting the VirtMacAddr Attribute ............................................................................

157

15.13 Setting the LegacyBootProto Attribute ....................................................................

158

15.14 Setting CNA LAN Modes ........................................................................................

159

15.15 Setting the iSCSI Boot Target .................................................................................

160

15.16 Setting the FCoE Boot Target .................................................................................

162

16 RAID Storage Management .............................................................................................

163

16.1

Listing the RAID Inventory-Enumeration Class .......................................................

163

16.2

Getting a RAID Enumeration Instance ....................................................................

165

16.3

Listing the RAID Inventory-Integer Class ................................................................

166

16.4

Getting a RAID Integer Instance .............................................................................

168

16.5

Listing the RAID Inventory-String Class ..................................................................

168

16.6

Getting a RAID String Instance ...............................................................................

169

16.7

Listing the RAID Inventory-ControllerView Class ....................................................

170

16.8

Getting a RAID ControllerView Instance .................................................................

171

16.9

Listing the RAID Inventory-PhysicalDiskView Class................................................

172

16.10 Listing the RAID VirtualDiskView Inventory .............................................................

173

16.11 Listing the RAID EnclosureView Inventory ..............................................................

175

16.12 Reset Configuration-ResetConfig() .........................................................................

176

16.13 Clearing the Foreign Configuration-ClearForeignConfig() .......................................

177

16.14 Applying the Pending Values for RAID-CreateTargetedConfigJob()........................

178

16.15 Deleting the Pending Values for RAID-DeletePendingConfiguration().....................

179

16.16 Managing Hot Spare ...............................................................................................

180

 

16.16.1

Determining Potential Disks-GetDHSDisks() ...........................................

180

 

16.16.2 Assigning the Hot Spare-AssignSpare() ..................................................

180

 

16.16.3 Unassigning the Hot Spare-UnassignSpare() ..........................................

182

16.17 Managing Keys for Self Encrypting Drives ..............................................................

182

 

16.17.1

Setting the Key-SetControllerKey() ..........................................................

182

 

16.17.2 Locking the Virtual Disk-LockVirtualDisk() ...............................................

183

 

16.17.3 Locking the Controller with a Key-EnableControllerEncryption() ..............

184

 

16.17.4

Rekeying the Controller-ReKey() .............................................................

185

 

16.17.5

Removing the Key-RemoveControllerKey() .............................................

187

16.18 Managing Virtual Disk .............................................................................................

187

 

16.18.1 Getting the Available RAID levels-GetRAIDLevels() ................................

187

 

16.18.2 Getting the Available Disks-GetAvailableDisks()......................................

189

 

16.18.3 Checking the Create VD Parameters Validity-CheckVDValues() .............

190

 

16.18.4 Creating a Single Virtual Disk-CreateVirtualDisk() ...................................

191

 

16.18.5 Creating a Sliced Virtual Disk-CreateVirtualDisk() ...................................

194

 

16.18.6 Creating a Cachecade Virtual Disk-CreateVirtualDisk() ...........................

196

 

16.18.7

Deleting a Virtual Disk-DeleteVirtualDisk()...............................................

198

16.19 Setting Controller Attributes ....................................................................................

198

 

 

7

 

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux Version: 2.1.0

 

 

16.19.1 Changing the Value of a RAID Controller Enumeration Attribute .............

198

 

 

16.19.2 Changing Multiple Values of RAID Controller Enumeration Attributes......

199

 

 

16.19.3 Changing the Value of a RAID Controller Integer Attribute ......................

200

 

 

16.19.4 Changing Multiple Values of RAID Controller Integer Attributes...............

201

 

16.20 Convert Physical Disks to RAID-ConvertToRAID() .................................................

202

 

16.21 Convert Physical Disks to Non RAID-ConvertToNonRAID()....................................

203

17

Managing BIOS Configuration..........................................................................................

204

 

17.1

Listing the BIOS Inventory-Enumeration Class .......................................................

204

 

17.2

Getting a BIOS Enumeration Instance ....................................................................

206

 

17.3

Changing the BIOS BootMode-SetAttribute() ..........................................................

206

 

17.4

Setting Multiple BIOS BootMode Parameters..........................................................

207

 

17.5

Listing the BIOS Inventory-Integer Class ................................................................

208

 

17.6

Listing the BIOS Inventory-String Class ..................................................................

208

 

17.7

Applying the Pending Values for BIOS & Boot-CreateTargetedConfigJob() ............

209

 

17.8

Deleting the Pending Values for BIOS & Boot-DeletePendingConfiguration() .........

211

 

17.9

Managing BIOS Passwords ....................................................................................

211

 

 

17.9.1 Setting the BIOS Password .........................................................................

211

 

 

17.9.2 Create Target Configuration Job .................................................................

213

 

 

17.9.3 Monitor Set BIOS Password Status.............................................................

213

 

17.10 Listing the BIOS Inventory-Password Class ............................................................

214

18 Exporting and Importing Server Profile.............................................................................

215

 

18.1

Exporting Server Profile ..........................................................................................

215

 

 

18.1.1 Exporting Server Profile to iDRAC vFlash Card-BackupImage()..................

216

 

 

18.1.2 Exporting Server Profile to NFS Share-BackupImage() ...............................

216

 

 

18.1.3 Exporting Server Profile to CIFS Share-BackupImage() ..............................

217

 

 

18.1.4 Monitoring Export status..............................................................................

218

 

18.2

Importing Server Profile ..........................................................................................

218

 

 

18.2.1 Importing Server Profile from iDRAC vFlash Card-RestoreImage() .............

219

 

 

18.2.2 Importing Server Profile from NFS share-RestoreImage() ...........................

219

 

 

18.2.3 Importing Server Profile from CIFS share-RestoreImage() ..........................

220

 

 

18.2.4 Monitoring Import Status .............................................................................

221

19

iDRAC Configuration........................................................................................................

222

 

19.1

Listing the iDRAC Card Inventory-Enumeration Class ............................................

222

 

19.2

Getting an iDRAC Card Enumeration Instance .......................................................

224

 

19.3

Listing the iDRAC Card Inventory-Enumeration Class using groupID .....................

225

 

19.4

Applying the Attributes and Polling Job Completion ................................................

226

 

 

19.4.1 Changing iDRAC Values-ApplyAttributes() (Immediate) ..............................

226

 

 

19.4.2 Polling Job Completion................................................................................

228

 

 

19.4.3 Set Attribute Verification ..............................................................................

229

 

19.5

Listing the iDRAC Card Inventory-Integer Class .....................................................

231

 

19.6

Listing the iDRAC Card Inventory-Integer Class using groupID ..............................

232

 

19.7

Listing the iDRAC Card Inventory-String Class .......................................................

233

 

 

8

 

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux Version: 2.1.0

 

19.8

Listing the iDRAC Card Inventory-String Class using groupID ................................

235

 

19.9

Changing the iDRAC IPChange Notification ...........................................................

237

 

 

19.9.1 Getting the Current iDRAC IPChange State ................................................

237

 

 

19.9.2 Setting the iDRAC IPChange Notification-SetAttribute() ..............................

237

20

Remote Service Status ....................................................................................................

238

 

20.1

Getting Remote Service Status...............................................................................

238

 

20.2

Restarting Remote Service Status ..........................................................................

240

21

System Information ..........................................................................................................

241

 

21.1

Listing the System Inventory-SystemView Class.....................................................

241

22

Sensor Information..........................................................................................................

244

 

22.1

Listing the Sensors Inventory-PSNumericSensor Class ..........................................

244

23 Managing Fiber Channel (FC) Configuration ....................................................................

245

 

23.1

Listing the FC Inventory-Attribute Class ..................................................................

245

 

23.2

Listing the FC Inventory-Statistics Class .................................................................

246

 

23.3

Listing the FC Inventory-String Class......................................................................

247

 

23.4

Listing the FC Inventory-Integer Class ....................................................................

248

 

23.5

Listing the FC Inventory-Enumeration Class ...........................................................

249

 

23.6

Changing the FC Attributes-SetAttribute()...............................................................

249

 

23.7

Applying the Pending Values for FC-CreateTargetedConfigJob() ...........................

250

 

23.8

Deleting the Pending Values for FC-DeletePendingConfiguration() ........................

251

 

23.9

Listing the FC Views ...............................................................................................

252

9

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

1 Introduction

This document serves as a guideline for utilizing the functionality available from embedded Lifecycle Controller Remote Enablement Web Services. 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

1.

The target audience for this document is application and script writers that want to utilize the remote management capabilities using WS-Man protocol available from Dell Lifecycle Controller.

2 References

1Dell 12th Generation PowerEdge Server Resources: http://www.delltechcenter.com/12thGen

2Dell CIM Profiles

http://www.delltechcenter.com/page/DCIM.Library.Profile

3 Managed Object Format (MOF) http://www.delltechcenter.com/page/DCIM.Library.MOF

4 WinRM Scripting API, MSDN: http://msdn.microsoft.com/en-us/library/aa384469(VS.85).aspx

5 Openwsman CLI: http://www.openwsman.org/project/wsmancli

6DMTF Common Information Model (CIM) Infrastructure Specification (DSP0004): http://www.dmtf.org/standards/published_documents/DSP0004_2.5.0.pdf

7List of PCI IDs:

10

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

http://pciids.sourceforge.net/pci.ids

11

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

3 Overview

The remote interface guidelines provided in this document are illustrated by command line 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 WinRM4 and WSMANCLI5 respectively. The Lifecycle Controller remote management capabilities are organized by management domain and documented in Dell CIM Profile specifications2. The remote enablement feature for Lifecycle Controller 2.0 provides the following 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

3.1Format for WSMAN 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 = $USERNAME

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:

12

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

EXAMPLE:

wsman enumerate http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_OSDeploymentService

-h $IPADDRESS -V -v -c dummy.cert -P 443 -u $USERNAME -p $PASSWORD

-j utf-8 -y basic

3.2WS-Man Security & Time Parameters

3.2.1Encryption Certificate Security

For the wsman 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 wsman examples: –v and V.

Refer to the wsman documentation4 and related documentation for directions on setting up encryption certificates for wsman and executing wsman invocations using full security capabilities. Refer to the Lifecycle Controller User Guide1 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.2Handling invalid responses from WSMAN commands

Check the network connection to make sure that the system is connected

Check the WSMAN syntax to ensure there are no typos in the command line

Check if there are other WSMAN commands sending from other systems

Wait for a few seconds and re-try the WSMAN command

3.2.3Improving WSMAN Enumeration Performance

Enumeration configuration only available for winRM.

3.2.4Specifying 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 Specification4 as:

ddddddddhhmmss.mmmmmm

Where:

13

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

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 2.0 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 2.0 updates and set attribute tasks.

TIME_NOW is a special value that represents “running the tasks immediately”.

3.2.5Return 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.6Glossary

 

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

 

 

 

 

 

 

 

 

UEFI

 

 

Unified Extensible Firmware Interface

 

 

AMEA

 

 

Advanced Management Enablement Adapter

 

 

HII

 

 

Human Interface Infrastructure

 

 

WSMAN

 

 

WS-Management is a specification of a SOAP-based protocol for the

 

 

 

 

 

management of servers, devices, applications and more

 

14

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

4 Discovery

4.1Discovering Web Service Capability

Determine if the target system supports the wsman interface using the ‘identify’ command.

Profiles: http://www.dmtf.org/sites/default/files/standards/documents/DSP0217_2.0.0.pdf EXAMPLE:

wsman identify

-h $IPADDRESS -V -v -c dummy.cert -P 443 -u $USERNAME -p $PASSWORD

-j utf-8 -y basic

-u:[USER] -p:[PASSWORD]

OUTPUT:

<wsmid:IdentifyResponse>

<wsmid:ProtocolVersion>http://schemas.dmtf.org/wbem/wsman/1/wsman

.xsd</wsmid:ProtocolVersion>

<wsmid:ProductVendor>Openwsman Project</wsmid:ProductVendor> <wsmid:ProductVersion>2.2.4</wsmid:ProductVersion>

</wsmid:IdentifyResponse>

4.2Discovering what Profiles are Implemented

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:

wsman enumerate http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/CIM_RegisteredProfile?__cimnamespace=root/interop

-h $IPADDRESS -V -v -c dummy.cert -P 443 -u $USERNAME -p $PASSWORD

-j utf-8 -y basic

OUTPUT:

<n1:DCIM_LCRegisteredProfile> <n1:AdvertiseTypeDescriptions>WS-Identify </n1:AdvertiseTypeDescriptions> <n1:AdvertiseTypeDescriptions>Interop Namespace </n1:AdvertiseTypeDescriptions> <n1:AdvertiseTypes>1</n1:AdvertiseTypes> <n1:AdvertiseTypes>1</n1:AdvertiseTypes>

15

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

<n1:InstanceID>DCIM:Memory:1.0.0</n1:InstanceID>

<n1:OtherRegisteredOrganization>DCIM</n1:OtherRegisteredOrganization>

<n1:RegisteredName>Memory</n1:RegisteredName>

<n1:RegisteredOrganization>1</n1:RegisteredOrganization>

<n1:RegisteredVersion>1.0.0</n1:RegisteredVersion> </n1:DCIM_LCRegisteredProfile>

...

<n1:DCIM_RegisteredProfile> <n1:AdvertiseTypeDescriptions>WS-Identify </n1:AdvertiseTypeDescriptions> <n1:AdvertiseTypes>1</n1:AdvertiseTypes> <n1:Caption xsi:nil="true"/> <n1:Description xsi:nil="true"/> <n1:ElementName xsi:nil="true"/>

<n1:InstanceID>DCIM:CSRegisteredProfile:1</n1:InstanceID> <n1:OtherRegisteredOrganization xsi:nil="true"/> <n1:RegisteredName>Base Server</n1:RegisteredName> <n1:RegisteredOrganization>2</n1:RegisteredOrganization> <n1:RegisteredVersion>1.0.0</n1:RegisteredVersion>

</n1:DCIM_RegisteredProfile>DCIM_RegisteredProfile

.

.

.

The above example shows that the DMTF Base Server profile version 1.0.0 is implemented.

4.3Discovering 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: (filtered for CIM_ComputerSystem)

wsman associators http://schemas.dmtf.org/wbem/wscim/1/*

--filter "http://schemas.dell.com/wbem/wscim/1/cimschema/2/CIM_RegisteredProfile?InstanceID=DCIM:CSRegisteredProfile:1"

--dialecthttp://schemas.dmtf.org/wbem/wsman/1/cimbinding/associationFilter-h $IPADDRESS -P 443 -u $USERNAME -p $PASSWORD -V -v -c dummy.cert

-j utf-8 -y basic -N root/interop

OUTPUT:

<n1:DCIM_ElementConformsToProfile> <n1:ConformantStandard>

<wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>

16

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

<wsa:ReferenceParameters>

<wsman:ResourceURI>http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_RegisteredProfile</wsman:ResourceURI>

<wsman:SelectorSet>

<wsman:Selector Name="InstanceID">DCIM:CSRegisteredProfile:1</wsman:Selector> <wsman:Selector Name="__cimnamespace">root/interop</wsman:Selector>

</wsman:SelectorSet>

</wsa:ReferenceParameters>

</n1:ConformantStandard>

<n1:ManagedElement>

<wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>

<wsa:ReferenceParameters>

<wsman:ResourceURI>http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_ComputerSystem</wsman:ResourceURI>

<wsman:SelectorSet>

<wsman:Selector Name="Name">srv:system</wsman:Selector>

<wsman:Selector Name="CreationClassName">DCIM_ComputerSystem</wsman:Selector> <wsman:Selector Name="__cimnamespace">root/dcim</wsman:Selector>

</wsman:SelectorSet>

</wsa:ReferenceParameters>

</n1:ManagedElement>

</n1:DCIM_ElementConformsToProfile>

The example shows that implementation namespace is “root/dcim”.

5 Managing iDRAC Local User Accounts

5.1Description of iDRAC Attributes vs 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.2Account 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

17

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

5.2.1Account 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:

wsman enumerate "http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_iDRACCardEnumeration"

-h $IPADDRESS -V -v -c dummy.cert -P 443 -u $USERNAME -p $PASSWORD

-j utf-8 -y basic

OUTPUT:

<n1:DCIM_iDRACCardEnumeration>

<n1:AttributeDisplayName>User Admin Enable</n1:AttributeDisplayName>

 

 

 

<n1:AttributeName>Enable</n1:AttributeName>

 

 

 

 

Account Disabled as displayed

 

<n1:CurrentValue>Disabled</n1:CurrentValue>

in CurrentValue attribute for

 

<n1:DefaultValue>Disabled</n1:DefaultValue>

 

 

 

 

 

 

Users.1

 

 

 

 

 

<n1:Dependency xsi:nil="true"/>

 

 

 

 

<n1:DisplayOrder>0</n1:DisplayOrder>

 

 

 

 

 

 

 

 

<n1:FQDD>iDRAC.Embedded.1</n1:FQDD>

 

 

 

 

<n1:GroupDisplayName>Users</n1:GroupDisplayName>

 

 

 

 

<n1:GroupID>Users.1</n1:GroupID>

 

 

 

 

<n1:InstanceID>iDRAC.Embedded.1#Users.1#Enable</n1:InstanceID>

<n1:IsReadOnly>true</n1:IsReadOnly>

<n1:PossibleValues>Disabled</n1:PossibleValues>

<n1:PossibleValues>Enabled</n1:PossibleValues> </n1:DCIM_iDRACCardEnumeration>

<n1:DCIM_iDRACCardEnumeration>

<n1:AttributeDisplayName>User Admin Enable</n1:AttributeDisplayName>

<n1:AttributeName>Enable</n1:AttributeName>

 

 

 

<n1:CurrentValue>Enabled</n1:CurrentValue>

 

 

 

<n1:DefaultValue>Enabled</n1:DefaultValue>

Account Enabled as

<n1:Dependency xsi:nil="true"/>

displayed in

<n1:DisplayOrder>0</n1:DisplayOrder>

CurrentValue attribute

 

 

 

<n1:FQDD>iDRAC.Embedded.1</n1:FQDD>

for

Users.2

 

 

 

 

<n1:GroupDisplayName>Users</n1:GroupDisplayName>

 

 

 

 

 

 

<n1:GroupID>Users.2</n1:GroupID>

 

 

 

<n1:InstanceID>iDRAC.Embedded.1#Users.2#Enable</n1:InstanceID>

 

 

 

<n1:IsReadOnly>false</n1:IsReadOnly>

 

 

 

<n1:PossibleValues>Disabled</n1:PossibleValues>

 

 

 

<n1:PossibleValues>Enabled</n1:PossibleValues>

 

 

 

</n1:DCIM_iDRACCardEnumeration>

 

 

 

18

 

 

 

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

.

.

.

5.2.2Privilege 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:

<n1:DCIM_iDRACCardEnumeration> <n1:AttributeDisplayName>User Admin IPMI LAN Privilege </n1:AttributeDisplayName> <n1:AttributeName>IpmiLanPrivilege</n1:AttributeName> <n1:CurrentValue>NoAccess</n1:CurrentValue> <n1:DefaultValue>NoAccess</n1:DefaultValue> <n1:Dependency xsi:nil="true"/> <n1:DisplayOrder>0</n1:DisplayOrder> <n1:FQDD>iDRAC.Embedded.1</n1:FQDD> <n1:GroupDisplayName>Users</n1:GroupDisplayName> <n1:GroupID>Users.1</n1:GroupID>

<n1:InstanceID>iDRAC.Embedded.1#Users.1#IpmiLanPrivilege

</n1:InstanceID>

<n1:IsReadOnly>true</n1:IsReadOnly>

<n1:PossibleValues>User</n1:PossibleValues>

<n1:PossibleValues>Operator</n1:PossibleValues>

<n1:PossibleValues>Administrator</n1:PossibleValues>

<n1:PossibleValues>NoAccess</n1:PossibleValues> </n1:DCIM_iDRACCardEnumeration>

<n1:DCIM_iDRACCardEnumeration> <n1:AttributeDisplayName>User Admin IPMI Serial Privilege</n1:AttributeDisplayName> <n1:AttributeName>IpmiSerialPrivilege</n1:AttributeName> <n1:CurrentValue>NoAccess</n1:CurrentValue> <n1:DefaultValue>NoAccess</n1:DefaultValue> <n1:Dependency xsi:nil="true"/> <n1:DisplayOrder>0</n1:DisplayOrder> <n1:FQDD>iDRAC.Embedded.1</n1:FQDD> <n1:GroupDisplayName>Users</n1:GroupDisplayName> <n1:GroupID>Users.1</n1:GroupID>

<n1:InstanceID>iDRAC.Embedded.1#Users.1#IpmiSerialPrivilege

</n1:InstanceID>

19

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

<n1:IsReadOnly>true</n1:IsReadOnly>

<n1:PossibleValues>User</n1:PossibleValues>

<n1:PossibleValues>Operator</n1:PossibleValues>

<n1:PossibleValues>Administrator</n1:PossibleValues>

<n1:PossibleValues>NoAccess</n1:PossibleValues> </n1:DCIM_iDRACCardEnumeration>

.

.

5.3Manage 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.1Modify User Name (using iDRAC Attributes)

EXAMPLE:

wsman invoke -a 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:iDRACC ardService

-h $IPADDRESS -V -v -c dummy.cert -P 443

-u $USERNAME -p $PASSWORD -j utf-8 -y basic -J 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> <p:AttributeValue>HELLO</p:AttributeValue>

</p:ApplyAttributes_INPUT>

OUTPUT:

When this method is executed, a jobid or an error message is returned.

<n1:ApplyAttributes_OUTPUT> <n1:Job>

<wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>

<wsa:ReferenceParameters>

<wsman:ResourceURI>http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LifecycleJob</wsman:ResourceURI>

20

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

<wsman:SelectorSet>

<wsman:Selector Name="InstanceID">JID_001299682234</wsman:Selector>

<wsman:Selector Name="__cimnamespace">root/dcim</wsman:Selector> </wsman:SelectorSet>

</wsa:ReferenceParameters>

</n1:Job>

<n1:ReturnValue>4096</n1:ReturnValue> </n1:ApplyAttributes_OUTPUT>

5.3.2Modify Password (using iDRAC Attributes)

EXAMPLE:

wsman invoke -a 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:iDRACC ardService"

-h $IPADDRESS -V -v -c dummy.cert -P 443

-u $USERNAME -p $PASSWORD -j utf-8 -y basic -J 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> </p:ApplyAttributes_INPUT>

OUTPUT:

When this method is executed, a jobid or an error message is returned.

<n1:ApplyAttributes_OUTPUT> <n1:Job>

<wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>

<wsa:ReferenceParameters>

<wsman:ResourceURI>http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LifecycleJob</wsman:ResourceURI>

<wsman:SelectorSet>

<wsman:Selector Name="InstanceID">JID_001299683297</wsman:Selector>

<wsman:Selector Name="__cimnamespace">root/dcim</wsman:Selector>

21

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

</wsman:SelectorSet>

</wsa:ReferenceParameters>

</n1:Job>

<n1:ReturnValue>4096</n1:ReturnValue> </n1:ApplyAttributes_OUTPUT>

5.3.3Modify Account State (using iDRAC Attributes)

When the account setting capability allows, the user account may be enabled or disabled by invoking the method ApplyAttributes() method on the Enable property. Confirmation of the change can be obtained by enumerating the DCIM_iDRACCardString class(Section 19.6).

EXAMPLE:

wsman invoke -a 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:iDRACC ardService"

-h $IPADDRESS -V -v -c dummy.cert -P 443

-u $USERNAME -p $PASSWORD -j utf-8 -y basic

-J DracCard_AccountChange.xml

The input file, DracCard_ AccountChange.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>PASSWORDHERE</p:AttributeValue>

</p:ApplyAttributes_INPUT>

OUTPUT:

When this method is executed, a jobid or an error message is returned.

ApplyAttributes_OUTPUT <n1:ApplyAttributes_OUTPUT>

<n1:Job>

<wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>

<wsa:ReferenceParameters>

<wsman:ResourceURI>http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LifecycleJob</wsman:ResourceURI>

<wsman:SelectorSet>

<wsman:Selector Name="InstanceID">JID_001299683957</wsman:Selector> <wsman:Selector Name="__cimnamespace">root/dcim</wsman:Selector>

22

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

</wsman:SelectorSet>

</wsa:ReferenceParameters>

</n1:Job>

<n1:ReturnValue>4096</n1:ReturnValue> </n1:ApplyAttributes_OUTPUT>

The following error may result if the password has not initially been set to a value. The password may be set an initail value at the same time as the account is enabled by adding the Users.4#Password attribute name and corresponding attribute value, as shown above.

<n1:ApplyAttributes_OUTPUT>

<n1:Message>The User Password is not configured so cannot Enable the User or set values for User Password IPMILan IPMISerial or User Admin Privilege</n1:Message>

<n1:MessageArguments>NULL</n1:MessageArguments>

<n1:MessageID>RAC023</n1:MessageID>

<n1:ReturnValue>2</n1:ReturnValue> </n1:ApplyAttributes_OUTPUT>

5.3.4Modify User Privilege (using iDRAC Attributes)

When the account setting capability allows, the user privileges may be enabled or disabled by invoking the method ApplyAttributes() method on the Enable property. Confirmation of the change can be obtained by enumerating the DCIM_iDRACCardString class(Section 19.6).

EXAMPLE:

wsman invoke -a 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:iDRACC ardService"

-h $IPADDRESS -V -v -c dummy.cert -P 443

-u $USERNAME -p $PASSWORD -j utf-8 -y basic

-J DracCard_PrivilegeChange.xml

The input file, DracCard_ PrivilegeChange.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#IpmiLanPrivilege</p:AttributeName> <p:AttributeValue>Operator</p:AttributeValue>

</p:ApplyAttributes_INPUT>

OUTPUT:

When this method is executed, a jobid or an error message is returned.

<n1:ApplyAttributes_OUTPUT> <n1:Job>

23

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

<wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>

<wsa:ReferenceParameters>

<wsman:ResourceURI>http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_LifecycleJob</wsman:ResourceURI>

<wsman:SelectorSet>

<wsman:Selector Name="InstanceID">JID_001299684480</wsman:Selector> <wsman:Selector Name="__cimnamespace">root/dcim</wsman:Selector>

</wsman:SelectorSet>

</wsa:ReferenceParameters>

</n1:Job>

<n1:ReturnValue>4096</n1:ReturnValue> </n1:ApplyAttributes_OUTPUT>

5.4Account Inventory (using DMTF Model)

The list of user accounts may be retrieved by enumerating the CIM_Account class. The class provides the user account name and EnabledState properties. The user account password is also included but it is a write-only property.

Profiles: http://www.dmtf.org/sites/default/files/standards/documents/DSP1034_1.0.1.pdf http://www.dmtf.org/sites/default/files/standards/documents/DSP1039_1.0.0.pdf

5.4.1Account and Capabilities (using DMTF Model)

Example-A demonstrates standard ouput. Example-B demonstrates EPR mode output.

EXAMPLE-A:

wsman enumerate "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_Account" -h $IPADDRESS -V –v -c dummy.cert -P 443

-u $USERNAME -p $PASSWORD -j utf-8 -y basic

OUTPUT-A:

<n1:DCIM_MFAAccount> <n1:AuthenticateMethod xsi:nil="true"/>

<n1:AvailableRequestedStates xsi:nil="true"/> <n1:Caption xsi:nil="true"/> <n1:CommunicationStatus xsi:nil="true"/> <n1:ComplexPasswordRulesEnforced xsi:nil="true"/>

<n1:CreationClassName>DCIM_MFAAccount</n1:CreationClassName> <n1:Description xsi:nil="true"/>

<n1:Descriptions xsi:nil="true"/> <n1:DetailedStatus xsi:nil="true"/>

24

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

<n1:ElementName>MFA Account 13</n1:ElementName> <n1:EnabledDefault>2</n1:EnabledDefault> <n1:EnabledState>3</n1:EnabledState> <n1:HealthState xsi:nil="true"/>

<n1:Host xsi:nil="true"/> <n1:InactivityTimeout xsi:nil="true"/> <n1:InstallDate xsi:nil="true"/> <n1:LastLogin xsi:nil="true"/> <n1:LocalityName xsi:nil="true"/>

<n1:MaximumSuccessiveLoginFailures xsi:nil="true"/> <n1:Name>DCIM User 13</n1:Name>

<n1:OU xsi:nil="true"/> <n1:ObjectClass xsi:nil="true"/> <n1:OperatingStatus xsi:nil="true"/> <n1:OperationalStatus xsi:nil="true"/>

<n1:OrganizationName>DCIM</n1:OrganizationName> <n1:OtherEnabledState xsi:nil="true"/> <n1:PasswordExpiration xsi:nil="true"/> <n1:PasswordHistoryDepth xsi:nil="true"/> <n1:PrimaryStatus xsi:nil="true"/> <n1:RequestedState>0</n1:RequestedState> <n1:SeeAlso xsi:nil="true"/>

<n1:Status xsi:nil="true"/> <n1:StatusDescriptions xsi:nil="true"/>

<n1:SystemCreationClassName>DCIM_SPComputerSystem </n1:SystemCreationClassName> <n1:SystemName>systemmc</n1:SystemName> <n1:TimeOfLastStateChange xsi:nil="true"/> <n1:TransitioningToState>12</n1:TransitioningToState> <n1:UserCertificate xsi:nil="true"/>

<n1:UserID/>

<n1:UserPassword xsi:nil="true"/> </n1:DCIM_MFAAccount>

<n1:DCIM_MFAAccount> <n1:AuthenticateMethod xsi:nil="true"/>

<n1:AvailableRequestedStates xsi:nil="true"/> <n1:Caption xsi:nil="true"/> <n1:CommunicationStatus xsi:nil="true"/> <n1:ComplexPasswordRulesEnforced xsi:nil="true"/>

<n1:CreationClassName>DCIM_MFAAccount</n1:CreationClassName> <n1:Description xsi:nil="true"/>

<n1:Descriptions xsi:nil="true"/>

25

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

<n1:DetailedStatus xsi:nil="true"/> <n1:ElementName>MFA Account 2</n1:ElementName> <n1:EnabledDefault>2</n1:EnabledDefault> <n1:EnabledState>2</n1:EnabledState> <n1:HealthState xsi:nil="true"/>

<n1:Host xsi:nil="true"/>

.

.

.

EXAMPLE-B:

wsman enumerate "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_Account" -h $IPADDRESS -V -v -c dummy.cert -P 443

-u $USERNAME -p $PASSWORD -j utf-8 -y basic -M epr

OUTPUT-B:

<wsa:EndpointReference>

<wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>

<wsa:ReferenceParameters>

<wsman:ResourceURI>http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_MFAAccount</wsman:ResourceURI>

<wsman:SelectorSet>

<wsman:Selector Name="SystemCreationClassName">DCIM_SPComputerSystem</wsman:Selector>

<wsman:Selector Name="SystemName">systemmc</wsman:Selector> <wsman:Selector Name="CreationClassName">DCIM_MFAAccount</wsman:Selector> <wsman:Selector Name="Name">DCIM User 1</wsman:Selector>

</wsman:SelectorSet>

</wsa:ReferenceParameters>

</wsa:EndpointReference>

<wsa:EndpointReference>

<wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address>

<wsa:ReferenceParameters>

<wsman:ResourceURI>http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_MFAAccount</wsman:ResourceURI>

<wsman:SelectorSet>

<wsman:Selector Name="SystemCreationClassName">DCIM_SPComputerSystem</wsman:Selector>

<wsman:Selector Name="SystemName">systemmc</wsman:Selector> <wsman:Selector Name="CreationClassName">DCIM_MFAAccount</wsman:Selector> <wsman:Selector Name="Name">DCIM User 2</wsman:Selector>

26

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

</wsman:SelectorSet>

</wsa:ReferenceParameters>

</wsa:EndpointReference>

.

.

.

Account setting capability is defined in the class CIM_AccountManagementCapabilities associated with the CIM_Account class instance. The ability to enable and disable an account is defined in the capability class CIM_EnabledLogicalElementCapabilities associated with the CIM_Account class.

To determine account setting capabilities:

1.Get the CIM_Account class instance of interest using EnumerateEPR mode.

2.Enumerate the associators of the CIM_Account instance and search for CIM_AccountManagementService class instance using EnumerateEPR mode.

3.Enumerate the associators of the CIM_AccountManagementService instance and search for CIM_AccountManagementCapabilities class instance.

4.One exception is account index 0. The first account is static and could not be set. OUTPUT-C:

<n1:DCIM_MFAManagementCapabilities> <n1:Caption xsi:nil="true"/> <n1:Description xsi:nil="true"/>

<n1:ElementName>MFAManagementCapabilities</n1:ElementName>

<n1:ElementNameEditSupported>false

</n1:ElementNameEditSupported> <n1:ElementNameMask xsi:nil="true"/> <n1:InstanceID>DCIM:MFAManagementCapabilities:1 </n1:InstanceID> <n1:MaxElementNameLen>0</n1:MaxElementNameLen> <n1:OperationsSupported>3</n1:OperationsSupported> <n1:RequestedStatesSupported xsi:nil="true"/> <n1:StateAwareness xsi:nil="true"/> <n1:SupportedAuthenticationMethod>0 </n1:SupportedAuthenticationMethod> <n1:SupportedAuthenticationMethod>1 </n1:SupportedAuthenticationMethod> <n1:SupportedAuthenticationMethod>2 </n1:SupportedAuthenticationMethod>

</n1:DCIM_MFAManagementCapabilities>

<n1:DCIM_IPMICLPAccountManagementCapabilities>

27

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

<n1:Caption xsi:nil="true"/> <n1:Description xsi:nil="true"/>

<n1:ElementName>IPMICLPAccountManagementCapabilities

</n1:ElementName>

<n1:ElementNameEditSupported>false

</n1:ElementNameEditSupported> <n1:ElementNameMask xsi:nil="true"/>

<n1:InstanceID>DCIM:IPMICLPAccountManagementCapabilities:1

</n1:InstanceID>

<n1:MaxElementNameLen>0</n1:MaxElementNameLen>

<n1:OperationsSupported>3</n1:OperationsSupported> <n1:RequestedStatesSupported xsi:nil="true"/> <n1:StateAwareness xsi:nil="true"/>

</n1:DCIM_IPMICLPAccountManagementCapabilities>

To determine account state setting capabilities:

1.Get the CIM_Account class instance of interest using EnumerateEPR mode.

2.Enumerate the associators of the CIM_Account instance and search for CIM_EnabledLogicalElementCapabilities class instance.

3.The presence of “RequestedStatesSupported” determines which states could be set.

4.One exception is account index 0. The first account is static and could not be set. OUTPUT-D:

<n1:DCIM_MFAEnabledLogicalElementCapabilities> <n1:Caption xsi:nil="true"/>

<n1:Description xsi:nil="true"/>

<n1:ElementName>Account Capabilities</n1:ElementName> <n1:ElementNameEditSupported>false </n1:ElementNameEditSupported>

<n1:ElementNameMask xsi:nil="true"/> <n1:InstanceID>DCIM:Account:Capabilities:1</n1:InstanceID> <n1:MaxElementNameLen>0</n1:MaxElementNameLen> <n1:RequestedStatesSupported>2</n1:RequestedStatesSupported> <n1:RequestedStatesSupported>3</n1:RequestedStatesSupported> <n1:StateAwareness xsi:nil="true"/>

</n1:DCIM_MFAEnabledLogicalElementCapabilities>

.

.

.

28

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

5.4.2Privilege and Capabilities (using DMTF Model)

The account privilege assigned to a user is defined in the class CIM_Privilege associated with the CIM_Account class. The class contains a list of privileges granted to the user account.

Profiles: http://www.dmtf.org/sites/default/files/standards/documents/DSP1034_1.0.1.pdf http://www.dmtf.org/sites/default/files/standards/documents/DSP1039_1.0.0.pdf

To get the instance of CIM_Privilege for an account:

1.Get the CIM_Account class instance of interest using EnumerateEPR mode.

2.Enumerate the associators of the CIM_Account instance and search for CIM_Identity class instance using EnumerateEPR mode.

3.Enumerate the associators of the CIM_Identity instance and search for CIM_Role class instance using EnumerateEPR mode.

4.Enumerate the associators of the CIM_Role instance and search for CIM_Privilege class instance.

An alternative to the above method, you can retrieve the specific CIM_Privilege instance by enumerating the class directly with filter. This method is similar to the example used to retrieve

CIM_Account.

EXAMPLE:

wsman enumerate http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_LocalRolePrivilege

-h $IPADDRESS -V -v -c dummy.cert -P 443

-u $USERNAME -p $PASSWORD -j utf-8 -y basic

OUTPUT:

<n1:DCIM_LocalRolePrivilege> <n1:Activities xsi:nil="true"/> <n1:ActivityQualifiers xsi:nil="true"/> <n1:Caption xsi:nil="true"/> <n1:Description xsi:nil="true"/> <n1:ElementName xsi:nil="true"/>

<n1:InstanceID>DCIM:Privilege:1</n1:InstanceID>

<n1:PrivilegeGranted>true</n1:PrivilegeGranted> <n1:QualifierFormats xsi:nil="true"/> <n1:RepresentsAuthorizationRights>false </n1:RepresentsAuthorizationRights>

29

Dell™ Lifecycle Controller 2 Web Services Interface Guide for Linux

Version: 2.1.0

</n1:DCIM_LocalRolePrivilege>

<n1:DCIM_LocalRolePrivilege> <n1:Activities>7</n1:Activities> <n1:Activities>7</n1:Activities> <n1:Activities>7</n1:Activities> <n1:Activities>7</n1:Activities> <n1:Activities>7</n1:Activities> <n1:Activities>7</n1:Activities> <n1:Activities>7</n1:Activities> <n1:Activities>7</n1:Activities> <n1:Activities>7</n1:Activities>

<n1:ActivityQualifiers>Login to DRAC</n1:ActivityQualifiers> <n1:ActivityQualifiers>Configure DRAC</n1:ActivityQualifiers> <n1:ActivityQualifiers>Configure Users </n1:ActivityQualifiers>

<n1:ActivityQualifiers>Clear Logs</n1:ActivityQualifiers> <n1:ActivityQualifiers>Execute Server Control Commands </n1:ActivityQualifiers>

<n1:ActivityQualifiers>Access Console Redirection </n1:ActivityQualifiers> <n1:ActivityQualifiers>Access Virtual Media </n1:ActivityQualifiers>

<n1:ActivityQualifiers>Test Alerts</n1:ActivityQualifiers> <n1:ActivityQualifiers>Execute Diagnostic Commands </n1:ActivityQualifiers>

<n1:Caption xsi:nil="true"/> <n1:Description xsi:nil="true"/> <n1:ElementName xsi:nil="true"/>

<n1:InstanceID>DCIM:Privilege:2</n1:InstanceID>

<n1:PrivilegeGranted>true</n1:PrivilegeGranted>

<n1:QualifierFormats>9</n1:QualifierFormats>

<n1:QualifierFormats>9</n1:QualifierFormats>

<n1:QualifierFormats>9</n1:QualifierFormats>

<n1:QualifierFormats>9</n1:QualifierFormats>

<n1:QualifierFormats>9</n1:QualifierFormats>

<n1:QualifierFormats>9</n1:QualifierFormats>

<n1:QualifierFormats>9</n1:QualifierFormats>

<n1:QualifierFormats>9</n1:QualifierFormats>

<n1:QualifierFormats>9</n1:QualifierFormats>

<n1:RepresentsAuthorizationRights>true

</n1:RepresentsAuthorizationRights> </n1:DCIM_LocalRolePrivilege>

30

Loading...
+ 223 hidden pages