Dell Enterprise Solution Resources Owner's manual

Fiber Channel Profile

Document Number: DCIM1056

Document Type: Specification

Document Status: Published

Document Language: E

Date: 2012-12-30

Version: 1.0.0

2 Version 1.0.0

THIS PROFILE 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. ABSENT A SEPARATE AGREEMENT

BETWEEN YOU AND DELL™ WITH REGARD TO FEEDBACK TO DELL ON THIS PROFILE

SPECIFICATION, YOU AGREE ANY FEEDBACK YOU PROVIDE TO DELL REGARDING THIS

PROFILE SPECIFICATION WILL BE OWNED AND CAN BE FREELY USED BY DELL.

permission of Dell, Inc. is strictly forbidden. For more information, contact Dell.

Dell and the DELL logo are trademarks of Dell Inc. Microsoft and WinRM 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.

Version 1.0.0 3

CONTENTS

1 Scope .................................................................................................................................................... 5

2 Normative References ........................................................................................................................... 5

3 Terms and Definitions ........................................................................................................................... 7

4 Symbols and Abbreviated Terms .......................................................................................................... 9

5 Synopsis .............................................................................................................................................. 10

6 Description .......................................................................................................................................... 10

6.1 Fully Qualified Device Descriptor (FQDD) ................................................................................ 11

6.2 Virtual Address attributes .......................................................................................................... 12

7 Implementation Description ................................................................................................................. 12

7.1 FC HBA View – DCIM_FCView ................................................................................................ 13

7.2 FC HBA Capabilities – DCIM_FCCapabilities .......................................................................... 16

7.3 FC HBA Statistics – DCIM_FCStatistics ................................................................................... 17

7.4 DCIM_FCEnumeration.............................................................................................................. 20

7.5 DCIM_FCString ......................................................................................................................... 21

7.6 DCIM_FCInteger ....................................................................................................................... 23

7.7 FC HBA Attributes ..................................................................................................................... 25

7.8 DCIM_FCService ...................................................................................................................... 29

7.9 Fiber Channel Profile Registration ............................................................................................ 30

8 Methods ............................................................................................................................................... 31

8.1 DCIM_FCService.SetAttribute() ............................................................................................... 31

8.2 DCIM_FCService.SetAttributes() ............................................................................................. 33

8.3 DCIM_FCService.CreateTargetedConfigJob() ........................................................................ 35

8.4 DCIM_FCService.DeletePendingConfiguration() ..................................................................... 37

9 Use Cases ........................................................................................................................................... 38

10 CIM Elements ...................................................................................................................................... 39

11 Privilege and License Requirement .................................................................................................... 39

ANNEX A (informative) Change Log ......................................................................................................... 40

4 Version 1.0.0

Figures

Figure 1 – Fiber Channel Profile: Class Diagram ....................................................................................... 11

Tables

Table 1 – Related Profiles ........................................................................................................................... 10

100

Table 3 – CIM Elements: Fiber Channel Profile.......................................................................................... 13

101

Table 4 – DCIM_FCView - Operations ....................................................................................................... 14

102

Table 5 – DCIM_FCView - Properties ......................................................................................................... 14

103

Table 6 – DCIM_FCCapabilities - Operations ............................................................................................. 16

104

Table 7 – DCIM_FCCapabilities - Properties .............................................................................................. 16

105

Table 8 – DCIM_FCStatistics - Operations ................................................................................................. 18

106

Table 9 – DCIM_FCStatistics - Properties .................................................................................................. 18

107

Table 10 – DCIM_FCEnumeration - Operations ......................................................................................... 20

108

Table 11 – Class: DCIM_FCEnumeration ................................................................................................... 21

109

Table 12 – DCIM_FCString - Operations .................................................................................................... 22

110

Table 13 – Class: DCIM_FCString .............................................................................................................. 23

111

Table 14 – DCIM_FCInteger - Operations .................................................................................................. 24

112

Table 15 – Class: DCIM_FCInteger ............................................................................................................ 25

113

Table 16 – DCIM_FCEnumeration Port Configuration ............................................................................... 25

114

Table 17 – DCIM_FCInteger Port Configuration ......................................................................................... 26

115

Table 18 – DCIM_FCString Port Configuration........................................................................................... 26

116

Table 19 – DCIM_FCEnumeration Fiber Channel Target Configuration .................................................... 27

117

Table 20 – DCIM_FCInteger Fiber Channel Target Configuration ............................................................. 27

118

Table 21 – DCIM_FCString Fiber Channel Target Configuration ............................................................... 27

119

Table 22 – DCIM_FCEnumeration HBA Configuration ............................................................................... 27

120

Table 23 – DCIM_FCInteger HBA Configuration ........................................................................................ 28

121

Table 24 – DCIM_FCString Firmware and Device Information .................................................................. 28

122

Table 25 – DCIM_FCService – Operations ................................................................................................ 29

123

Table 26 – Class: DCIM_FCService ........................................................................................................... 30

124

Table 27 – DCIM_LCRegisteredProfile - Operations .................................................................................. 30

125

Table 28 – Class: DCIM_LCRegisteredProfile ............................................................................................ 30

126

Table 29 – DCIM_FCService.SetAttribute() Method: Return Code Values ............................................... 32

127

Table 30 – DCIM_FCService.SetAttribute() Method: Parameters ............................................................. 32

128

Table 31 – DCIM_FCService.SetAttribute() Method: Standard Messages ................................................ 32

129

Table 32 – DCIM_FCService.SetAttributes() Method: Return Code Values .............................................. 33

130

Table 33 – DCIM_FCService.SetAttributes() Method: Parameters ............................................................ 33

131

Table 34 – DCIM_FCService.SetAttributes() Method: Standard Messages .............................................. 34

132

Table 35 – DCIM_FCService.CreateTargetedConfigJob() Method: Return Code Values ......................... 35

133

Table 36 – DCIM_FCService.CreateTargetedConfigJob() Method: Parameters ....................................... 36

134

Table 37 – DCIM_FCService.CreateTargetedConfigJob() Method: Standard Messages ......................... 36

135

Table 38 – DCIM_FCService.DeletePendingConfiguration() Method: Return Code Values ..................... 37

136

Table 39 – DCIM_FCService.DeletePendingConfiguration() Method: Parameters ................................... 37

137

Table 40 – DCIM_FCService.DeletePendingConfiguration() Method: Standard Messages...................... 38

138

Table 41 – Privilege and License Requirements ........................................................................................ 39

139

140

Version 1.0.0 5

Fiber Channel Profile

141

1 Scope

142

The Fiber Channel Profile extends the management capabilities of referencing profiles by adding the

143

capability to represent the configuration of fiber channel host bus adapters (FC HBA). The FC HBAs are

144

modeled as views and attributes where there is a view for each individual controller and multiple attributes

145

that allow FC HBA configuration.

146

2 Normative References

147

Refer to the following documents for more information.

148

NOTE: For dated references, only the edition cited applies. For undated references, the latest edition of

149

the referenced document (including any amendments) applies.

150

 DMTF DSP1033, Profile Registration Profile 1.0.0

151

 DMTF DSP1061, Management Profile 1.0.0

152

 DMTF DSP0200, CIM Operations over HTTP 1.2.0

153

 DMTF DSP0004, CIM Infrastructure Specification 2.3.0

154

 DMTF DSP1000, Management Profile Specification Template

155

 DMTF DSP1001, Management Profile Specification Usage Guide

156

 DMTF DSP0226, Web Services for Management (WS-Management) Specification 1.1.0

157

 DMTF DSP0227, WS-Management CIM Binding Specification 1.0.0

158

 Dell Lifecycle Controller Best Practices Guide 1.0,

159

http://en.community.dell.com/techcenter/extras/m/white_papers/20066173.aspx

160

 Dell WSMAN Licenses and Privileges 1.0

161

 ISO/IEC Directives, Part 2, Rules for the structure and drafting of International Standards:

162

http://isotc.iso.org/livelink/livelink.exe?func=ll&objId=4230456&objAction=browse&sort=subtype

163

 Unified Modeling Language (UML) from the Open Management Group (OMG):

164

http://www.uml.org

165

 Dell Tech Center MOF Library:

166

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

167

 Related Managed Object Format (MOF) files:

168

o DCIM_FCAttribute

169

o DCIM_FCEnumeration.mof

170

o DCIM_FCInteger.mof

171

o DCIM_FCService.mof

172

o DCIM_FCString.mof

173

o DCIM_FCView.mof

174

o DCIM_FCCapabilities.mof

175

o DCIM_FCStatistics.mof

176

o DCIM_LCElementConformsToProfile.mof

177

6 Version 1.0.0

o DCIM_LCRegisteredProfile.mof

178

179

Version 1.0.0 7

3 Terms and Definitions

180

For the purposes of this document, the following terms and definitions apply.

181

3.1

182

can - Used for statements of possibility and capability, whether material, physical, or causal.

183

3.2

184

cannot - Used for statements of possibility and capability, whether material, physical, or causal.

185

3.3

186

conditional - Indicates requirements to be followed strictly in order to conform to the document when the

187

specified conditions are met.

188

3.4

189

mandatory - Indicates requirements to be followed strictly in order to conform to the document and from

190

which no deviation is permitted.

191

3.5

192

may - Indicates a course of action permissible within the limits of the document.

193

3.6

194

need not - Indicates a course of action permissible within the limits of the document.

195

3.7

196

optional - Indicates a course of action permissible within the limits of the document.

197

3.8

198

referencing profile - Indicates a profile that owns the definition of this class and can include a reference

199

to this profile in its “Related Profiles” table.

200

3.9

201

shall - Indicates requirements to be followed strictly in order to conform to the document and from which

202

no deviation is permitted

203

3.10

204

shall not – Indicates requirements to be followed strictly in order to conform to the document and from

205

which no deviation is permitted.

206

3.11

207

should – Indicates that among several possibilities, one is recommended as particularly suitable, without

208

mentioning or excluding others, or that a certain course of action is preferred but not necessarily required.

209

3.12

210

should not – Indicates that a certain possibility or course of action is deprecated but not prohibited.

211

8 Version 1.0.0

3.13

212

Interop Namespace: root/interop

213

Interop Namespace: root/interop is where instrumentation instantiates classes to advertise its capabilities

214

for client discovery.

215

3.14

216

Implementation Namespace: root/dcim

217

Implementation Namespace: root/dcim is where instrumentation instantiates classes relevant to executing

218

core management tasks.

219

3.15

220

ENUMERATE - Refers to WS-MAN ENUMERATE operation as described in Section 8.2 of

221

DSP0226_V1.1 and Section 9.1 of DSP0227_V1.0

222

3.16

223

GET - Refers to WS-MAN GET operation as defined in Section 7.3 of DSP00226_V1.1 and Section

224

7.1 of DSP0227_V1.0

225

Version 1.0.0 9

4 Symbols and Abbreviated Terms

226

4.1

227

CIM - Common Information Model

228

4.2

229

iDRAC - Integrated Dell Remote Access Controller – management controller for blades and monolithic

230

servers

231

4.3

232

CMC - Chassis Management Controller – management controller for the modular chassis

233

4.4

234

iSCSI - Internet Small Computer System Interface, an Internet Protocol (IP)-based storage networking

235

standard for linking data storage facilities.

236

4.5

237

WBEM - Web-Based Enterprise Management

238

4.6

239

SRIOV - Singel Root I/O Virtualization

240

4.7

241

NPIV - N_Port ID Virtualization

242

4.8

243

DCB - Data Center Bridging

244

4.9

245

FCF - FCoE Forwarders

246

4.10

247

FC HBA – Fiber Channel Host Bus Adapter

248

249

250

10 Version 1.0.0

5 Synopsis

251

Profile Name: Fiber Channel

252

Version: 1.0.0

253

Organization: Dell Inc.

254

CIM Schema Version: 2.26 Experimental

255

Central Class: DCIM_FCService

256

Scoping Class: CIM_ComputerSystem

257

The Fiber Channel Profile extends the management capability of the referencing profiles by adding the

258

capability to describe fibre channel (FC) controllers in a simple way. In this profile, a FC HBA is

259

represented by a view instance that aggregates zero or more instances of the DCIM_FCAttribute class,

260

each representing an FC HBA related configurable property.

261

DCIM_FCService shall be the Central Class.

262

CIM_ComputerSystem shall be the Scoping Class.

263

Instance of DCIM_FCService shall be the Central Instance.

264

Instance of CIM_ComputerSystem shall be the Scoping Instance.

265

Table 1 identifies profiles that are related to this profile.

266

Table 1 – Related Profiles

267

Profile Name

Organization

Version

Relationship

Profile Registration

DCIM

1.0

Reference

6 Description

268

The Fiber Channel Profile describes FC HBA’s representation and configuration. The profile also

269

describes the relationship of the Fiber Channel Profile classes to the Dell profile version information.

270

Figure 1 represents the class schema for the Fiber Channel Profile. For simplicity, the prefix CIM_ has

271

been removed from the names of the classes.

272

The DCIM_FCView class is a FC HBA’s representation that contains controllers’ properties.

273

The DCIM_FCCapabilities class represents FC HBA’s capabilities.

274

The DCIM_FCStatistics class represents FC HBA’s port statistics.

275

The DCIM_FCAttribute class derives from the CIM_BIOSAttribute class and represents each FC’s

276

configurable attribute.Depending on the data type of the attribute, DCIM_FCAttribute is either instantiated

277

as DCIM_FCEnumeration, DCIM_FCString, or DCIM_FCInteger instance.

278

DCIM_FCView instance represents the FC HBA.

279

The DCIM_FCService class is used to configure the FC HBA through its attributes. The SetAttribute() and

280

SetAttributes() methods on the DCIM_FCService class configure FC HBA attributes, DCIM_FCAttribute

281

subclass instances.

282

The Fiber Channel Profile information is represented with the instance of CIM_RegisteredProfile.

283

Version 1.0.0 11

DCIM_FCView

DCIM_LCRegisteredProfile

RegisteredProfile = “Fiber Channel”

OtherRegisteredOrganization = “DCIM”

DCIM_LCElementConformsToProfile

DCIM_FCAttribute

DCIM_FCEnumeration DCIM_FCInteger

CIM_BIOSAttribute

Interop

Namespace

Implementation

Namespace

DCIM_FCCapabilities DCIM_FCStatistics

DCIM_FCService

DCIM_FCString

284

Figure 1 – Fiber Channel Profile: Class Diagram

285

6.1 Fully Qualified Device Descriptor (FQDD)

286

Fully Qualified Device Descriptor (FQDD) is a component identifier that uniquely represents a specific

287

system device or component in a platform independent of the operating system, and the device vendor.

288

The DCIM data model utilizes FQDDs to correlate different aspects of representing a component, such as

289

hardware inventory view, configurable attribute, software inventory and so on. FQDDs are used by

290

software, such as BIOS, UEFI applications that link Unified Server Configurator (USC), and remote

291

management applications to identify various system components in a persistent way.

292

For FC HBA, the FQDD is used to uniquely identify a particular port. See Table 2 - FC HBA FQDD

293

examples.

294

295

12 Version 1.0.0

Table 2 - FC HBA FQDD examples

296

FQDD

Friendly Name

FC.Slot.3-2

FC HBA in Slot 3 Port 2

FC.Mezzanine.1B-1

FC HBA in Mezzanine 1 Port 1

297

6.2 Virtual Address attributes

298

Virtual address attributes include the following attributes:

299

 Virtual World Wide Node Name (VirtualWWN)

300

 Virtual World Wide Port Name (VirtualWWPN)

301

The default values of these virtual attributes is equal to the permanent addresses programmed onto the

302

controller.

303

To set these attributes, see Section 8.1 and 8.2 for more details. Virtual address attributes behave

304

differently from the other attributes in the following way:

305

6.2.1 Read Write behavior

306

Generally, the virtual address attributes, as listed above, are read-write attributes through the Lifecycle

307

Controller Remote Services WSMAN interface. This feature allows a remote application to change the

308

virtual identities of FC HBA. However, on number of FC HBA cards these attributes may not be settable,

309

such as the later revisions of QLogic

8Gb Fibre Channel Adapter. For those FC HBA adapters, the

310

IsReadonly property on the virtual attribute instances will have value TRUE.

311

6.2.2 Reset behavior

312

Setting a particular virtual address attribute to zeros causes that particular address to be erased and reset

313

to the default permanent address. The attributes can be set to default permanent values: as equivalent to

314

resetting to factory default and removing a virtual address attribute from a system.

315

When there is AC Power loss to the system, all the virtual address attributes are erased and reset to

316

default addresses when AC Power is restored to the system. AC Power loss includes power loss to both

317

MAIN and AUX power bus.

318

7 Implementation Description

319

Requirements and guidelines for propagating and formulating certain properties of the classes are

320

discussed in this section. Methods are listed in section 8.

321

Table 3 shows the instances of CIM Elements for this profile. Instances of the CIM Elements shall be

322

implemented as described in Table 3. Sections 7 (“Implementation Requirements” and “Methods”) may

323

impose additional requirements on these elements.

324

Version 1.0.0 13

Table 3 – CIM Elements: Fiber Channel Profile

325

Element Name

Requirement

Description

Classes

DCIM_FCService

Mandatory

The class maybe implemented in the

Implementation Namespace: root/dcim.

See sections 7.8

DCIM_FCView

Mandatory