White Papers

ManualsBrandsDell ManualsSoftwareLifecycle Controller 1.4

Document Status: Published

Steven Zessin

December 18, 2012

Version 2.1.0

Dell™ Lifecycle Controller 2 Web

Services Interface Guide for Windows

Summary of content (226 pages)

PAGE 1
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Steven Zessin December 18, 2012 Version 2.1.
PAGE 2
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 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.
PAGE 3
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 CONTENTS 1 2 3 4 5 6 7 Introduction ........................................................................................................................ 10 References ........................................................................................................................ 10 Overview ....................................................................................................................
PAGE 4
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 7.2.2 Create Reboot Job ........................................................................................ 35 7.2.3 Schedule Update Jobs .................................................................................. 35 7.2.4 Monitor Update Jobs ..................................................................................... 35 7.3 BIOS Firmware “Rollback” ....................................................
PAGE 5
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 10.2.2 Delete Job Queue ......................................................................................... 66 10.2.3 List Jobs in Job Store .................................................................................... 67 11 Operating System Deployment .......................................................................................... 69 11.1 OS Deployment Profile Implementation Conformance ...........
PAGE 6
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 12.9 Set Public Certificates ............................................................................................... 98 12.10 Set iDRAC Certificate and Private Key...................................................................... 99 12.11 Delete Auto-Discovery Server Public Key ............................................................... 100 12.12 Insert Comment in Lifecycle Controller Log .................
PAGE 7
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 15.10 Setting the IscsiOffloadMode Attribute .................................................................... 136 15.11 Setting the MaxBandwidth Attribute ........................................................................ 138 15.12 Setting the VirtMacAddr Attribute ............................................................................ 139 15.13 Setting the LegacyBootProto Attribute ........................
PAGE 8
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 16.19.1 Changing the Value of a RAID Controller Enumeration Attribute ............. 179 16.19.2 Changing Multiple Values of RAID Controller Enumeration Attributes...... 179 16.19.3 Changing the Value of a RAID Controller Integer Attribute ...................... 180 16.19.4 Changing Multiple Values of RAID Controller Integer Attributes............... 181 16.20 Convert Physical Disks to RAID-ConvertToRAID() ................
PAGE 9
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 20 21 22 23 Version: 2.1.0 19.8 Listing the iDRAC Card Inventory-String Class using groupID ................................ 210 19.9 Changing the iDRAC IPChange Notification ........................................................... 212 19.9.1 Getting the Current iDRAC IPChange State ................................................ 212 19.9.2 Setting the iDRAC IPChange Notification-SetAttribute() ..............................
PAGE 10
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 1 Version: 2.1.0 Introduction This document serves as a guideline for utilizing the functionality available from embedded Lifecycle Controller Remote Enablement Web Services interfaces. The purpose of this document is to provide information and examples for utilizing the Web services for Management (WS-Man) management protocol using Windows WinRM and open source WSMANCLI command line utilities.
PAGE 11
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 7 List of PCI IDs: http://pciids.sourceforge.net/pci.ids 11 Version: 2.1.
PAGE 12
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 3 Version: 2.1.0 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.
PAGE 13
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 The following example is typical of the formatting used in this document: EXAMPLE: winrm e cimv2/root/dcim/DCIM_OSDeploymentService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman:443 -encoding:utf-8 -a:basic 3.2 WS-Man Security & Time Parameters 3.2.
PAGE 14
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 3.2.3 Improving WinRM Enumeration Performance When an enumeration command is executed, the default WinRM configuration gets only 20 instances at a time and therefore slows down the system drastically. Changing the WinRM configuration to allow a greater number, such as 50, will reduce the time taken by the enumeration operations. Execute the following command to get instances in groups of up to 50.
PAGE 15
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 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 firmware update, and set attribute related methods that require a date time parameter, use the form YYYYMMDDhhmmss (Eg. 20090930112030).
PAGE 16
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 4 4.1 Version: 2.1.0 Discovery Discovering Web Service Capability Determine if the target system supports the WinRM interface using the ‘identify’ command. Profiles: http://www.dmtf.org/sites/default/files/standards/documents/DSP0217_2.0.0.pdf EXAMPLE: winrm identify -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT: IdentifyResponse ProtocolVersion = http://schemas.dmtf.
PAGE 17
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 AdvertiseTypeDescriptions = WS-Identify AdvertiseTypes = 1 Caption = null Description = null ElementName = null InstanceID = DCIM:CSRegisteredProfile:1 OtherRegisteredOrganization = null RegisteredName = Base Server RegisteredOrganization = 2 RegisteredVersion = 1.0.0 . . . The above example shows that the DMTF Base Server profile version 1.0.0 is implemented. 4.
PAGE 18
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 DCIM_CSRoleLimitedToTarget DefiningRole Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.com/wbem/wscim/1/cim-schema/2/DCIM_Role SelectorSet Selector: CreationClassName = DCIM_Role, Name = DCIM:Role:10, __cimnamespace = root/dcim TargetElement Address = http://schemas.xmlsoap.
PAGE 19
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -r:https://[IPADDRESS]/wsman:443 -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT: DCIM_iDRACCardEnumeration AttributeDisplayName = User Admin Enable AttributeName = Enable CurrentValue = Disabled DefaultValue = Disabled Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = Users GroupID = Users.1 InstanceID = iDRAC.Embedded.1#Users.
PAGE 20
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 InstanceID = iDRAC.Embedded.1#Users.1#IpmiLanPrivilege IsReadOnly = true PossibleValues = User, Operator, Administrator, NoAccess DCIM_iDRACCardEnumeration AttributeDisplayName = User Admin IPMI Serial Privilege AttributeName = IpmiSerialPrivilege CurrentValue = NoAccess DefaultValue = NoAccess Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = Users GroupID = Users.1 InstanceID = iDRAC.
PAGE 21
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 When this method is executed, a jobid or an error message is returned. ApplyAttributes_OUTPUT ReturnValue = 4096 Job EndpointReference Address = https://127.0.0.1:443/wsman ReferenceParameters ResourceURI = http://schemas.dell.com/wbem/wscim/1/cim-schema/2/DCIM_LifecycleJob SelectorSet Selector: __cimnamespace = root/dcim, InstanceID = JID_001296571842 5.3.
PAGE 22
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 5.3.3 Modify 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: winrm i ApplyAttributes http://schemas.dmtf.
PAGE 23
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 5.3.4 Modify 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: winrm i ApplyAttributes http://schemas.dmtf.
PAGE 24
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 EXAMPLE-A: winrm e http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_Account -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT-A: DCIM_Account CreationClassName = DCIM_Account ElementName = DCIM Account EnabledDefault = 2 EnabledState = 3 Name = iDRAC.Embedded.1#Users.
PAGE 25
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Selector: __cimnamespace = root/dcim, Name = iDRAC.Embedded.1#Users.1, CreationClassName = DCIM_Account, Sys temName = systemmc, SystemCreationClassName = DCIM_SPComputerSystem EndpointReference Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.
PAGE 26
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 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.
PAGE 27
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm e http://schemas.dmtf.
PAGE 28
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 3. Enumerate the associators of the CIM_RoleBasedAuthorizationService instance and search for CIM_RoleBasedManagementCapabilities class instance using EnumerateEPR mode.
PAGE 29
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 The steps below demonstrate how to set the user name and password for local accounts. A) Enumerate CIM_Account with EPR to identify all possible instance information to be used in a subsequent put or set operations. EXAMPLE-A: winrm e http://schemas.dmtf.
PAGE 30
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -r:https://[IPADDRESS] -u:[USER] -p:[PASSWORD] -a:basic -encoding:utf-8 –SkipCACheck –SkipCNCheck When this method is executed, the particular object will be returned. Below is the output. OUTPUT-B: DCIM_Account CreationClassName = DCIM_Account ElementName = DCIM Account EnabledDefault = 2 EnabledState = 3 Name = iDRAC.Embedded.1#Users.
PAGE 31
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 RequestedState = 0 SystemCreationClassName = DCIM_SPComputerSystem SystemName = systemmc TransitioningToState = 12 UserID = testuser4 UserPassword = null UserID = testuser4 UserPassword = testuser4 D) If the account specified is new or not yet enabled, it will not be accessible. Login as root in the UI and verify the user name is set correctly and enable it. E) Logout of the UI.
PAGE 32
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 an instance reference. The instance reference may be retrieved by adding EnumerateEPR mode to enumerate or get of the class. 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 Replace “DCIM User 16” with the applicable user name and “2” with the desired request state.
PAGE 33
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.
PAGE 34
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm e cimv2/root/dcim/DCIM_SoftwareIdentity -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman:443 -auth:basic -encoding:utf-8 When this method is executed, a list of software identity objects will be returned, including installed and available firmware. Below is a snippet of the output.
PAGE 35
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 InstallationDate: The date when the payload was installed to the system. If the system time was not set when the firmware installation took place the install date will be 1970-01-01. Factory installed firmware will have the 1970-01-01 date. VersionString: Shows the version of the firmware represented. 7 Firmware Update 7.
PAGE 36
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 DCIM_LifecycleJob InstanceID = JID_001276741956 JobStartTime = TIME_NA JobStatus = Downloaded JobUntilTime = TIME_NA Message = Package successfully downloaded. MessageArguments = null MessageID = RED002 Name = Rollback:DCIM:AVAILABLE:NONPCI:159:2.1.
PAGE 37
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows  Version: 2.1.0 This refers BIOS version 2.1.4 EXAMPLE: winrm i InstallFromSoftwareIdentity cimv2/root/dcim/ DCIM_SoftwareInstallationService ?CreationClassName=DCIM_SoftwareInstallationService +SystemCreationClassName=DCIM_ComputerSystem +SystemName=IDRAC:ID +Name=SoftwareUpdate -file:RollInputBIOS.xml -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman:443 -auth:basic -encoding:utf-8 The rollback input file, RollInputBIOS.
PAGE 38
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Invoke InstallFromSoftwareIdentity with the following parameters and syntax: [InstanceID]: This is the instanceID of the SoftwareIdentify that is to be used to rollback the firmware to a previous version. The InstanceID can have value such as: DCIM:PREVIOUS:PCI:14E4:1639:0237:1028  It refers to a previous firmware on a PCI device.
PAGE 39
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Address = http://schemas.xmlsoap.org/ws /2004/08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.
PAGE 40
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 7.5.5 Delete Job The fifth and final stage is to delete the completed job from the job store. Deleting the job queue is shown in Section 10.2.2. 7.6 Update NICs from HTTP, CIFS Share, NFS share, TFTP, or FTP The InstallFromURI() method takes the following input and downloads the Dell Update Package to the Lifecycle Controller in the target system.
PAGE 41
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 EXAMPLE: winrm invoke InstallFromURI cimv2/root/dcim/DCIM_SoftwareInstallationService ?CreationClassName=DCIM_SoftwareInstallationService +SystemCreationClassName=DCIM_ComputerSystem +SystemName=IDRAC:ID+Name=SoftwareUpdate -file:UpdateInputNIC.xml -u:[UserName] -p:[Password] -r:https://[IPADDRESS]/wsman:443 -SkipCNCheck -auth:basic -encoding:utf-8 The above command takes in an input file named UpdateInputNic.
PAGE 42
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 ReturnValue = null Missing XML parameters may yield the following error message: InstallFromURI_OUTPUT Message = Insufficient Method Parameters MessageID = SUP001 ReturnValue = null 7.7 Update BIOS from HTTP, CIFS Share, NFS share, TFTP, or FTP The InstallFromURI() method takes the following input and downloads the Dell Update Package to the Lifecycle Controller in the target system.
PAGE 43
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm invoke InstallFromURI cimv2/root/dcim/DCIM_SoftwareInstallationService ?CreationClassName=DCIM_SoftwareInstallationService +SystemCreationClassName=DCIM_ComputerSystem +SystemName=IDRAC:ID+Name=SoftwareUpdate -file:UpdateInputBIOS.xml -u:[UserName] -p:[Password] -r:https://[IPADDRESS]/wsman:443 -SkipCNCheck -auth:basic -encoding:utf-8 The above command takes in an input file named UpdateInputBIOS.
PAGE 44
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 7.8 Version: 2.1.0 CreateRebootJob() The CreateRebootJob() method creates a reboot job that can be scheduled to reboot immediately or at a later time. When the reboot job is scheduled and then executed, via SetupJobQueue() (Section 10.2.1), the reboot will take several minutes depending on the system setup, including whether collecting system inventory (CSIOR) is enabled.
PAGE 45
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Jobid = InstanceID = RID_001265648530 8 8.1 Power State Management Description of Base Server vs Power State Management Methods The remote control of a server power state (On, Off) and methodology for cycling power is available through data models specified in both the DMTF Base Server Profile and the DMTF Power State Management Profile.
PAGE 46
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 OtherIdentifyingInfo = 4c4c4544-0036-3510-8034-b7c04f333231, mainsystemchassis, 7654321 PrimaryStatus = 3 RequestedState = 0 8.2.2 Power State Management Method The power state of the system is also reported by the PowerState property of the DCIM_CSAssociatedPowerManagementService class. Power State Management Profile: http://www.dmtf.org/sites/default/files/standards/documents/DSP1027_2.0.0.
PAGE 47
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 ResourceURI = http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_ComputerSystem SelectorSet Selector: Name = srv:system, CreationClassName = DCIM_ComputerSystem, __cimnames pace = root/dcim 8.3 Get Power Control Capabilites 8.3.
PAGE 48
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 . EXAMPLE (Part B): winrm g http://schemas.dell.
PAGE 49
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT: When the PowerStatesSupported property contains the value in the “PowerStatesSupported Value” column, the PowerChangeCapabilities property shall contain the value specified in the “PowerChangeCapabilities Value” column.
PAGE 50
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 instance for the main system and another for iDRAC. Use the main system instance. The method requires you to specify the RequestedState argument. Refer to Section 8.3 to get the possible values for this argument. Base Server Profile: http://www.dmtf.org/sites/default/files/standards/documents/DSP1004_1.0.1.pdf EXAMPLE: winrm invoke RequestStateChange "http://schemas.dell.
PAGE 51
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 9 Version: 2.1.0 Hardware Inventory The Dell Common Information Model (CIM) class extensions for supporting remote hardware inventories are defined in the various Dell profiles and related MOFs3. The Hardware Inventory allows users to remote query the inventory of hardware.
PAGE 52
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 InputVoltage = 118 InstanceID = PSU.Slot.2 LastSystemInventoryTime = 20100331101859 LastUpdateTime = 20100401130929 Manufacturer = Dell Model = PWR SPLY,502W,RDNT PartNumber = 0MU791A00 PrimaryStatus = 1 RedundancyStatus = 2 SerialNumber = CN7324597O0446 TotalOutputPower = 502 Type = 0 9.2 Fan Inventory This section describes the requirements and guidelines for implementing Dell Fan Profile.
PAGE 53
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 LastSystemInventoryTime = 20100331101859 LastUpdateTime = 20100408115623 PrimaryStatus = 1 RateUnits = 4 RedundancyStatus = 2 UnitModifier = 0 VariableSpeed = true . . . 9.3 Memory Inventory This section describes the implementation for the DCIM_MemoryView class. The Dell Memory Profile describes platform’s physical memory. Each DIMM’s information is represented by an instance of DCIM_MemoryView class.
PAGE 54
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 FQDD = DIMM.Socket.A3 InstanceID = DIMM.Socket.A3 LastSystemInventoryTime = 20100331101859 LastUpdateTime = 20100325134947 ManufactureDate = Mon Jun 29 12:00:00 2009 UTC Manufacturer = Samsung MemoryType = 24 Model = DDR3 DIMM PartNumber = M391B2873DZ1-CH9 PrimaryStatus = 1 Rank = 1 SerialNumber = 85C6DE0A Size = 1024 Speed = 1333 . . . 9.
PAGE 55
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Cache2Size = 2048 Cache2Type = 5 Cache2WritePolicy = 0 Cache3Associativity = 14 Cache3ErrorMethodology = 5 Cache3Level = 2 Cache3PrimaryStatus = 1 Cache3SRAMType = 2 Cache3Size = 20480 Cache3Type = 5 Cache3WritePolicy = 0 Characteristics = 4 CurrentClockSpeed = 2266 ExternalBusClockSpeed = 5860 FQDD = CPU.Socket.2 InstanceID = CPU.Socket.
PAGE 56
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -encoding:utf-8 -SkipCACheck –SkipCNCheck OUTPUT: DCIM_iDRACCardView FQDD = iDRAC.Embedded.1 FirmwareVersion = 1.00.00 GUID = 314b544f-c0b5-5180-5210-00484c4c454 IPMIVersion = 2.0 InstanceID = iDRAC.Embedded.
PAGE 57
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 PCIVendorID = 8086 SlotLength = 0002 SlotType = 0002 DCIM_PCIDeviceView BusNumber = 0 DataBusWidth = 0002 Description = 5520/5500/X58 I/O Hub PCI Express Root Port 3 DeviceNumber = 3 FQDD = P2PBridge.Embedded.4-1 FunctionNumber = 0 InstanceID = P2PBridge.Embedded.
PAGE 58
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 FunctionNumber = 0 InstanceID = Video.Embedded.1-1 LastSystemInventoryTime = 20100331101859 LastUpdateTime = 20100325134947 Manufacturer = Matrox Graphics, Inc. PCIDeviceID = 0532 PCISubDeviceID = 0236 PCISubVendorID = 1028 PCIVendorID = 102B SlotLength = 0002 SlotType = 0002 9.
PAGE 59
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 The NIC Profile describes NIC controller’s representation and configuration. The profile also describes the relationship of the NIC classes to the DMTF/Dell profile version information. See Section 15 for more information, including inventories for NICString, NICInteger, and NICEnumeration. Profile and Associated MOFs: http://www.delltechcenter.com/page/DCIM.Library.
PAGE 60
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 VendorName = null WWPN = null iScsiOffloadMode = 3 DCIM_NICView AutoNegotiation = 0 BusNumber = 1 ControllerBIOSVersion = 1.3 CurrentMACAddress = 00:21:9B:92:70:59 DataBusWidth = 000 2 DeviceNumber = 0 EFIVersion = null FCoEOffloadMode = 3 FCoEWWNN = null FQDD = NIC.Embedded.2-1 FamilyVersion = null FunctionNumber = 1 InstanceID = NIC.Embedded.
PAGE 61
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 contains all the methods used to configure the RAID storage. See Section 16 for more information, including inventories for PhysicalDiskView, VirtualDiskView, and EnclosureView. Profile and Associated MOFs: http://www.delltechcenter.com/page/DCIM.Library.Profile Enumerate ControllerView with the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 62
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 9.11 Version: 2.1.0 BIOS Inventory & Configuration The BIOS Management Profile extends the management capabilities of referencing profiles by adding the capability to represent and configure BIOS attributes, such as a Network Controller or IDE Controller. The individual BIOS attribute’s relationship with a respective device is also described.
PAGE 63
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 DisplayOrder = 319 FQDD = BIOS.Setup.1-1 GroupDisplayName = Memory Settings GroupID = MemSettings InstanceID = BIOS.Setup.1-1:SerialDbgOut IsReadOnly = false PendingValue = null PossibleValues = Enabled, Disabled PossibleValuesDescription = Enabled, Disabled DCIM_BIOSEnumeration AttributeDisplayName = Password Status AttributeName = PasswordStatus CurrentValue = Unlocked Dependency = null DisplayOrder = 1405 FQDD = BIOS.
PAGE 64
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows BladeGeometry = 4 BoardPartNumber = 0N051FX02 BoardSerialNumber = CN1374092O003M CMCIP = null CPLDVersion = 0.4.7 CPURollupStatus = 1 ChassisName = Main System Chassis ChassisServiceTag = 7654321 ChassisSystemHeight = 2 ExpressServiceCode = 61387326761 FQDD = System.Embedded.1 FanRollupStatus = 3 HostName InstanceID = System.Embedded.
PAGE 65
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 10 Job Control Management 10.1 Description of Job Management The Dell Common Information Model (CIM) class extensions for supporting update and attribute configuration job control are defined in the Dell Job Control Profile2 and related MOF files3. The diagrams representing the classes that are implemented by the Lifecycle Controller firmware can be found in Dell Job Control Profile as well.
PAGE 66
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 TIME_NOW 20100730121500 Here the JobArray element shows a list of Jobids that are to be scheduled to run. TIME_NOW is a special value that represents “running the tasks immediately”. The UntilTime value specifies the “maintenance windows”. Once a task is not run after passing UntilTime, it should not be run again.
PAGE 67
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -r:https://[IPADDRESS]/wsman:443 -auth:basic -encoding:utf-8 The example below uses JID_CLEARALL for the jobID, which is a predefined value that represents “deleting all jobs in the jobstore”.
PAGE 68
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm e cimv2/root/dcim/DCIM_LifecycleJob -u:[USERNAME] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman:443 -auth:basic -encoding:utf-8 OUTPUT 1 & 2: The method either returns a list of Concrete job objects or an error message. Once job instanceID are returned via these status queries, they can be used for job scheduling and setup. Several examples of job objects are shown below.
PAGE 69
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 11 Operating System Deployment The Dell Common Information Model (CIM) class extensions for supporting remote operating system (OS) deployment are defined in the Dell OS Deployment Profile2 and the DCIM_OSDeploymentService MOF file3. The diagrams representing the classes that are implemented by the Lifecycle Controller firmware can be found in Dell OS Deployment Profile as well. Profile and Associated MOFs: http://www.
PAGE 70
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 11.3.1 Get Driver Pack Information The GetDriverPackInfo() method returns the embedded driver pack version and list of supported OSs for OS deployment that can be installed on the server using the embedded device drivers present in the Lifecycle Controller. 1. Follow the steps listed in Section 11.1 to test for profile conformance. 2. Invoke extrinsic method using the following parameters: a.
PAGE 71
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Version = 7.0.0.35 11.3.2 Unpack Selected Drivers and Attach to Host OS as USB Device This method is used to unpack the drivers for the selected OS to a virtual storage partition, and to then attach this partition to the host OS as an emulated USB storage device. 1. Invoke extrinsic method using the following parameters section: a. object path = object path returned from Section 11.1 (profile conformance) b.
PAGE 72
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 /2004/08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.com/wbem /wscim/1/cim-schema/2/DCIM_OSDConcreteJob SelectorSet Selector: InstanceID = DCIM_OSDConcreteJob:1, __cimnamespace = root/dcim ReturnValue = 4096 11.3.3 Detach Emulated USB Device Containing Drivers This method is used to detach the USB device attached to the system by a previous invocation of the UnpackAndAttach() method.
PAGE 73
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 [DRIVESHARE]: This is the directory path to the drivers. [CIFS_USERNAME]: This is the username to the file share. [CIFS_PASSWORD]: This is the password to the file share. [OSName]: This example uses Windows Server® 2003 SP2.
PAGE 74
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 When the jobs are complete, the JobStatus property value will be “Successful” if the job completed successfully or “Failed” if an error occurred while executing the request. If the job failed, the Message property on the returned DCIM_OSDConcreteJob instance will contain more detailed error information on the cause of the failure.
PAGE 75
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 [OS.ISO]: This is to be replaced by the actual name of the ISO image.
PAGE 76
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 This method is used to detach the emulated USB device that had been attached by previously calling the BootToNetworkISO() method.
PAGE 77
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 11.3.9 Version: 2.1.
PAGE 78
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.
PAGE 79
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.
PAGE 80
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 DeleteISOFromVFlash_OUTPUT Message = ISO Image not found on VFlash MessageID = OSD41 ReturnValue = 2 11.3.13 Detach ISO from VFlash The DetachISOFromVFlash() method will detach the ISO image in the VFlash from the system.
PAGE 81
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 [CIFS_or_NFS_Username]: This is the username to the IP address of the ISO image. [CIFS_or_NFS_Password]: This is the corresponding password to the username containing the ISO image. [OS.ISO]: This is to be replaced by the actual name of the ISO image. EXAMPLE: winrm i ConnectNetworkISOImage http://schemas.dmtf.
PAGE 82
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 EXAMPLE: winrm i DisconnectNetworkISOImage http://schemas.dmtf.
PAGE 83
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Success: SkipISOImageBoot_OUTPUT ReturnValue = 0 11.3.17 Get Network ISO Image Connection Information This method outputs the ISO connection status of the image that has been exposed to the host.
PAGE 84
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 [SHAREUSER]: User account for the ISO share location [SHAREPASSWORD]: Password of the share account [WORKGROUP]: Applicable workgroup [IMAGENAME]: Image name of the iso image, such as boot.iso.
PAGE 85
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 cimv2/root/dcim/DCIM_OSDeploymentService ?CreationClassName=DCIM_OSDeploymentService +Name=DCIM:OSDeploymentService +SystemCreationClassName=DCIM_ComputerSystem +SystemName=DCIM:ComputerSystem -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman:443 -SkipCNCheck -SkipCACheck -encoding:utf-8 -a:basic OUTPUT: DisconnectRFSISOImage_OUTPUT ReturnValue = 0 11.3.
PAGE 86
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 EXAMPLE: winrm i BootToHD cimv2/root/dcim/DCIM_OSDeploymentService ?CreationClassName=DCIM_OSDeploymentService +Name=DCIM:OSDeploymentService +SystemCreationClassName=DCIM_ComputerSystem +SystemName=DCIM:ComputerSystem -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman:443 -encoding:utf-8 -a:basic OUTPUT: BootToHD_OUTPUT ReturnValue = 0 11.3.
PAGE 87
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Workgroup="WORKGROUP";ImageName="[OS.ISO]"} OUTPUT: The return will be 0 for success or 1 if an error occurred in starting the processing the input parameters. The MessageID and Message output parameters will further contain method invocation information if an error occurred. ConfigurableBootToNetworkISO_OUTPUT Job Address = http://schemas.xmlsoap.
PAGE 88
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows   Version: 2.1.0 Disabled (default) = Disallow collecting inventory on restart Enabled = Allow collecting system inventory on restart The Part Firmware Update attribute flags whether the Part Replacement automatic firmware update performed.
PAGE 89
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -r:https://[IPADDRESS]:443/wsman -u:[USER] -p:[PASSWORD] -auth:basic -encoding:utf-8 -SkipCNCheck -SkipCACheck The input file SetAttributes_LC.xml is shown below: PAGE 90
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 The above command will schedule the job at 10pm. To poll for job completion, enumerate the DCIM_LifecycleJob job instance. OUTPUT: CreateConfigJob_OUTPUT Job Address = http://schemas.xmlsoap.org/ws/2004 /08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.
PAGE 91
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm e http://schemas.dell.
PAGE 92
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 OUTPUT: DCIM_LCEnumeration AttributeName = Collect System Inventory on Restart CurrentValue = Disabled DefaultValue = Enabled ElementName = LC.emb.1 InstanceID = LifecycleController.Embedded.1#LCAttributes.1#CollectSystemInventoryOnRestart IsReadOnly = false PendingValue = null PossibleValues = Enabled, Disabled 12.2.
PAGE 93
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 [PS_IP_ADDRESS]: Substitution will need to be replaced with the actual IP address(s) or DNS name(s) of the Provisioning Server(s).
PAGE 94
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 +SystemName=DCIM:ComputerSystem +Name=DCIM:LCService -u:[USERNAME] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -encoding:utf-8 -a:basic OUTPUT-A: This method will return status 0 or error message.
PAGE 95
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 12.5 Version: 2.1.0 Check VFlash License Enablement The following command can be used to check VFlash License enablement. Features such as Part Replacement, downloading ISO image to VFlash, or booting from VFlash are licensed features and require Dell VFlash SD Card to be inserted in order to function. EXAMPLE: winrm g cimv2/root/dcim/DCIM_LCEnumeration ?InstanceID=LifecycleController.Embedded.1#LCAttributes.
PAGE 96
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 The input file DownloadServerPublicKey.xml is shown below: -----BEGIN CERTIFICATE----MIIEQjCCA6ugAwIBAgIBADANBgkqhkiG9w0BAQQFADCBzTELMAkGA1UEBhMCVVMx CzAJBgNVBAgTAlRYMRQwEgYDVQQHEwtNYWluIFN0cmVldDEVMBMGA1UEChMMSm9l . . .
PAGE 97
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -encoding:utf-8 -a:basic -file:DownloadClientCerts.xml The input file DownloadClientCerts.xml is shown below: PAGE 98
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows EXAMPLE: winrm i DeleteAutoDiscoveryClientCerts http://schemas.dmtf.
PAGE 99
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 ROncFRPIp7c= -----END CERTIFICATE---- OUTPUT: SetPublicCertificate_OUTPUT ReturnValue = 0 12.10 Set iDRAC Certificate and Private Key This method is used to update an iDRAC certificate and private key pairs using the contents of a PKCS#12 file.
PAGE 100
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 1234567 OUTPUT: SetCertificateAndPrivateKey_OUTPUT Message = Server certificate successfully modified, iDRAC will now reset and be unavailable for a few minutes MessageID = LC018 ReturnValue = 0 12.11 Delete Auto-Discovery Server Public Key This method is used to delete the public server key set previously by the set auto discovery method.
PAGE 101
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -encoding:utf-8 -a:basic -file:InsertCommentInLCLog.xml The input file InsertCommentInLCLog.xml is shown below: INSERT COMMENT HERE OUTPUT: InsertCommentInLCLog_OUTPUT ReturnValue = 0 12.
PAGE 102
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 sharename filename.txt 0 admin password workgroup OUTPUT: When this method is executed, a jobid or an error message is returned. ExportLCLog_OUTPUT Job Address = http://schemas.xmlsoap.
PAGE 103
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 +Name=DCIM:LCService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:ExportHWInventory.xml The input file ExportHWInventory.xml is shown below: 123.456.7.8 sharename filename.
PAGE 104
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Workgroup: This is the applicable workgroup. EXAMPLE: winrm i ExportFactoryConfiguration http://schemas.dmtf.
PAGE 105
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 +SystemName=DCIM:ComputerSystem +Name=DCIM:LCService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT: LCWipe_OUTPUT ReturnValue = 0 12.17 Get Remote Services API Status The GetRemoteServicesAPIStatus() method is used to obtain the overall remote services API status that includes both the host system status as well as the remote services (Data Manager) status.
PAGE 106
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 IPAddress: This is the IP address of the target export server. ShareName: This is the directory path to the mount point. FileName: This is the target output file. ShareType: Type of share NFS=0, CIFS=2 Username: This is the username to the target export server. Password: This is the password to the target export server. EXAMPLE: winrm i ExportSystemConfiguration http://schemas.dmtf.
PAGE 107
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 FileName: This is the target output file. ShareType: Type of share NFS=0, CIFS=2 Username: This is the username to the target export server. Password: This is the password to the target export server. EXAMPLE: winrm i ImportSystemConfiguration http://schemas.dmtf.
PAGE 108
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows      Version: 2.1.0 Detaching an attached partition Uploading an image to a partition Booting to a partition Modifying a partition Copying/exporting the contents of the partition Profile and Associated MOFs: http://www.delltechcenter.com/page/DCIM.Library.Profile 13.1 Listing the SD Card Partitions Each partition on the virtual flash media shall be represented by an instance of DCIM_OpaqueManagementData.
PAGE 109
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 13.2.1 Get VFlash SD Card Inventory DCIM_VFlashView is a subclass of CIM_View that is used to represent the physical attributes of the virtual flash media, such as total size, available size, category etc. on which the partitions will reside. Enumerate the DCIM_VFlashView with the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 110
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 When this method is executed, a jobid or an error message is returned. InitializeMedia_OUTPUT Job Address = http://schemas.xmlsoap.org/ws/2004 /08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.com/wbem SelectorSet Selector: InstanceID = JID_001268732835, __cimnamespace = root/dcim ReturnValue = 0 13.2.
PAGE 111
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 13.3 Version: 2.1.0 Enable/Disable VFlash using VFlash State Change This method is used to enable or disable the virtual flash media device. When the VFlashStateChange() method is successfully executed, the change will be dictated in the VFlashEnabledState parameter as shown in Section 13.2.1 and Section 13.2.3.
PAGE 112
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 MB=1, GB=2 PartitionType: The partition type floppy=1, hard disk=2 OSVolumeLabel: The label seen in the OS after attaching the partition EXAMPLE: winrm i CreatePartition http://schemas.dell.
PAGE 113
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 13.5 Version: 2.1.0 Create Partition using Image This method creates a partition on the storage device using the image provided by the user. The partition size will be the same as the size of the image. The maximum size of the image is 4GB. The image can be located on a NFS/CIFS share or on a TFTP server.
PAGE 114
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm i CreatePartitionUsingImage http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_PersistentStorageService ?SystemCreationClassName=DCIM_ComputerSystem +CreationClassName=DCIM_PersistentStorageService +SystemName=DCIM:ComputerSystem +Name=DCIM:PersistentStorageService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:CreatePartitionUsingImage.
PAGE 115
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 13.6 Version: 2.1.0 Delete Partition This method is for deleting a partition on a storage device. When this method is successfully executed, the instance of DCIM_OpaqueManagementData representing the desired partition along with the association instance of DCIM_ServiceAffectsElement will be deleted. The AvailableSize property of the associated storage media will increase by the size of the deleted partition.
PAGE 116
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.
PAGE 117
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 13.8 Version: 2.1.0 Modify Partition This method is used for modifying the changeable attributes of a partition. Use the following algorithm to successfully modify an existing partition.
PAGE 118
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Invoke AttachPartition() with the following parameters and syntax: PartitionIndex: The PartitionIndex property of the DCIM_OpaqueManagementData instance that represents the partition to be attached 1 to 16 EXAMPLE: winrm i AttachPartition http://schemas.dell.
PAGE 119
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm i DetachPartition http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_PersistentStorageService ?SystemCreationClassName=DCIM_ComputerSystem +CreationClassName=DCIM_PersistentStorageService +SystemName=DCIM:ComputerSystem +Name=DCIM:PersistentStorageService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:DetachPartition.
PAGE 120
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.
PAGE 121
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 When this method is executed, a jobid or an error message is returned. ExportDataFromPartition_OUTPUT Job Address = http://schemas.xmlsoap.org/ws/2004/08/addressing /role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.
PAGE 122
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 InstanceID = BCV IsCurrent = 2 IsDefault = 0 IsNext = 2 DCIM_BootConfigSetting ElementName = UefiBootSeq InstanceID = UEFI IsCurrent = 2 IsDefault = 0 IsNext = 2 DCIM_BootConfigSetting ElementName = OneTimeBootMode InstanceID = OneTime IsCurrent = 2 IsDefault = 0 IsNext = 2 DCIM_BootConfigSetting ElementName = vFlash Boot Configuration InstanceID = vFlash IsCurrent = 2 IsDefault = 0 IsNext = 2 14.
PAGE 123
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 IsDefault = 0 IsNext = 1 14.3 Listing the Boot Inventory-SourceSetting Class Each Boot Configuration Representation contains an ordered list of boot sources, which indicate the logical devices to use during the boot process. Enumerate the BootSourceSetting class with the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 124
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 The CurrentAssignedSequence attribute of each instance, from Section 14.3, defines the instance’s place in the zero based indexed boot sequence. Note: In order for the changes to be applied, the CreateTargetedConfigJob() method in Section 17.7 must be executed.
PAGE 125
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 [INSTANCE ID]: Obtained from the BootSourceSetting Class enumeration, this example uses the field IPL source: Reference to the InstanceID attribute from Section 14.3 EnabledState: State of boot source element Disabled=0, Enabled=1 EXAMPLE: winrm i ChangeBootSourceState http://schemas.dmtf.
PAGE 126
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 3. DCIM_NICInteger (see Section 15.3) 4. DCIM_NICView (see Section 15.4) 5. DCIM_NICCapabilities(see Section 15.5) 6. DCIM_NICStatistics(see Section 15.6) Profile and Associated MOFS: http://www.delltechcenter.com/page/DCIM.Library.Profile 15.1 Listing the NIC/CNA Inventory-Enumeration Class Enumerate the NICEnumeration class with the following parameters and syntax: EXAMPLE – CNA: winrm e http://schemas.dmtf.
PAGE 127
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 PossibleValues = Disabled, Enabled PossibleValuesDescription = Disabled, Enabled DCIM_NICEnumeration AttributeDisplayName = iSCSI Parameters via DHCP AttributeName = IscsiViaDHCP CurrentValue = Enabled Dependency = Unavailable FQDD = NIC.Integrated.1-1-1 GroupDisplayName = iSCSI General Parameters GroupID = IscsiGenParams InstanceID = NIC.
PAGE 128
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows GroupDisplayName = Broadcom Main Configuration Page GroupID = VndrConfigPage InstanceID = NIC.Integrated.1-1-1:ChipMdl IsReadOnly = true MaxLength = 0 MinLength = 0 PendingValue = null ValueExpression = null DCIM_NICString AttributeDisplayName = PCI Device ID AttributeName = PCIDeviceID CurrentValue = 165F Dependency = null FQDD = NIC.Integrated.
PAGE 129
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 . . 15.3 Listing the CNA Inventory-Integer Class Enumerate the DCIM_NICInteger class with the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 130
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 GroupDisplayName = iSCSI General Parameters GroupID = IscsiGenParams InstanceID = NIC.Integrated.1-1-1:LunBusyRetryCnt IsReadOnly = false LowerBound = 0 PendingValue = null UpperBound = 60 DCIM_NICInteger AttributeDisplayName = TCP Port AttributeName = FirstTgtTcpPort CurrentValue = 3260 Dependency = Unavailable FQDD = NIC.Integrated.
PAGE 131
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows InstanceID = NIC.Integrated.1-1-1 LastSystemInventoryTime = 20010708151620.000000+000 LastUpdateTime = 20010708151606.
PAGE 132
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 ProductName = Broadcom Gigabit Ethernet BCM5720 - 14:FE:B5:FF:B3:EB ReceiveFlowControl = 0 SlotLength = 0002 SlotType = 0002 TransmitFlowControl = 0 VendorName = null WWPN = null iScsiOffloadMode = 3 15.5 Listing the CNA Inventory-NICCapabilities Class Enumerate the DCIM_NICCapabilities class with the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 133
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 RemotePHY = 3 TCPChimneySupport = 3 TXBandwidthControlMaximum = 3 TXBandwidthControlMinimum = 3 TXFlowControl = 3 VEBVEPAMultiChannel = 3 VEBVEPASingleChannel = 3 VFSRIOVSupport = 3 VirtualLinkControl = 3 WOLSupport = 2 iSCSIBootSupport = 2 iSCSIOffloadSupport = 3 uEFISupport = 2 15.
PAGE 134
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 TxBroadcast = 0 TxBytes = null TxErrorPktExcessiveCollision = null TxErrorPktLateCollision = null TxErrorPktMultipleCollision = null TxErrorPktSingleCollision = null TxMutlicast = 74 TxPauseXOFFFrames = 0 TxPauseXONFrames = 0 TxUnicast = 193 15.
PAGE 135
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 NIC.Integrated.1-1-1 1 TIME_NOW 20201111111111 OUTPUT: When this method is executed, a jobid or an error message is returned. The status of this jobid can be checked within the job control provider in Section 10.
PAGE 136
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 OUTPUT: DeletePendingConfiguration_OUTPUT Message = The command was successful MessageID = NIC001 ReturnValue = 0 15.9 Getting the CNA Enumeration Instance Use the following example to get an instance of the DCIM_NICEnumeration class.
PAGE 137
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 For Broadcom CNA cards, the partitions on each port can be set to any personality. NICMode can always be enabled or disabled for any of the given partitions. For the IscsiOffloadMode and FcoeOffloadMode personalities, up to two personalities can be enabled on each port. For the Qlogic CNA cards, partition three can be set to either NICMode or IscsiOffloadMode.
PAGE 138
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 15.11 Setting the MaxBandwidth Attribute The SetAttribute() method is used to set or change the value of a CNA attribute. The MinBandwidth and MaxBandwidth attributes control the bandwidth allocations for a given CNA partition. The values are displayed in percentage. For Broadcom CNA cards, the MinBandwidth attribute values for a given port must always add up to either 0 or 100.
PAGE 139
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 MessageID = NIC001 RebootRequired = Yes ReturnValue = 0 SetResult = Set PendingValue 15.12 Setting the VirtMacAddr Attribute The SetAttribute() method is used to set or change the value of a CNA attribute. The I/O identity string attributes: (VirtMacAddr, VirtIscsiMacAddr, VirtFIPMacAddr, VirtWWN, and VirtWWPN) display a unique behavior.
PAGE 140
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 RebootRequired = Yes ReturnValue = 0 SetResult = Set PendingValue 15.13 Setting the LegacyBootProto Attribute The SetAttribute() method is used to set or change the value of a NIC attribute. WARNING: The local BIOS setting always overwrites the LegacyBootProto option. This option is only applied in the BIOS setup.
PAGE 141
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 RebootRequired = Yes ReturnValue = 0 SetResult = Set PendingValue 15.14 Setting CNA LAN Modes The SetAttributes() method is used to set or change the values of a group of NIC attributes. Invoke SetAttributes() with the following parameters (from Section 15.
PAGE 142
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 RebootRequired = Yes ReturnValue = 0 SetResult = Set PendingValue 15.15 Setting the iSCSI Boot Target The SetAttributes() method is used to set or change the values of the iSCSI boot target attributes. Invoke the SetAttributes() method with the following parameters (from 15.
PAGE 143
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 testname IscsiInitiatorChapId testid IscsiInitiatorChapPwd testpassword FirstTgtIpAddress 2.2.2.
PAGE 144
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:SetAttribute_FCoE_BootTarget.xml The information in the input file SetAttributes_FCoE_BootTarget.xml is shown below: NIC.Integrated.
PAGE 145
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 DCIM_VirtualDiskView (16.10) DCIM_EnclosureView (16.11) 16.1 Listing the RAID Inventory-Enumeration Class The RAID Inventory has these attributes: DCIM_RAIDEnumeration (this section), DCIM_RAIDInteger (Section 16.3), and DCIM_RAIDString (see Section 16.5). Enumerate the DCIM_RAIDEnumeration class to display all the RAID controllers and virtual disk attributes in a system.
PAGE 146
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 CurrentValue = WriteBack FQDD = Disk.Virtual.1:RAID.Integrated.1-1 InstanceID = Disk.Virtual.1:RAID.Integrated.1-1:RAIDdefaultWritePolicy IsReadOnly = false PendingValue PossibleValues = WriteThrough, WriteBack, WriteBackForce 16.2 Getting a RAID Enumeration Instance Use the following example to get an instance of the DCIM_RAIDEnumeration class instead of all the instances as shown in Section 16.1.
PAGE 147
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -schema/2/root/dcim/DCIM_RAIDInteger -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman:443 -SkipCNCheck -SkipCACheck -encoding:utf-8 -a:basic OUTPUT: DCIM_RAIDInteger AttributeName = RAIDmaxPDsInSpan CurrentValue = 32 FQDD = RAID.Integrated.1-1 InstanceID = RAID.Integrated.
PAGE 148
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 LowerBound = 1 PendingValue UpperBound = 100 16.4 Getting a RAID Integer Instance Use the following example to get an instance of the DCIM_RAIDInteger class, instead of all instances as shown in Section 16.3. Get a RAIDInteger instance with the following parameters and syntax: [INSTANCEID]: This is obtained from the enumeration in Section 16.3, which shows an example using RAID.Integrated.
PAGE 149
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 OUTPUT: DCIM_RAIDString AttributeName = Name CurrentValue = MyCacheCadeVD FQDD = Disk.Virtual.0:RAID.Integrated.1-1 InstanceID = Disk.Virtual.0:RAID.Integrated.1-1:Name IsReadOnly = true MaxLength = 15 MinLength = 0 PendingValue The ‘get’ instance method in Section 16.6 uses this InstanceID as input. DCIM_RAIDString AttributeName = Name CurrentValue = raid 1 vd FQDD = Disk.Virtual.1:RAID.Integrated.
PAGE 150
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 PendingValue 16.7 Listing the RAID Inventory-ControllerView Class The DCIM_ControllerView class groups together a set of Controller properties. Enumerate ControllerView with the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 151
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 16.8 Version: 2.1.0 Getting a RAID ControllerView Instance The get() command can be invoked using a particular instanceID, attained from listing the inventory. Get a RAID ControllerView instance with the following parameters and syntax: [INSTANCEID]: This is obtained from the enumeration in Section 16.7, in which this example would use RAID.Slot.1-1 as an instanceID EXAMPLE: winrm g http://schemas.dmtf.
PAGE 152
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 16.9 Version: 2.1.0 Listing the RAID Inventory-PhysicalDiskView Class Enumerating the PhysicalDiskView, results in the attributes and inventory of the available physical disks in the system. Enumerate PhysicalDiskView with the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 153
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 FQDD = Disk.Bay.1:Enclosure.Internal.0-0:RAID.Slot.1-1 FreeSizeInBytes = 8978432 HotSpareStatus = 0 InstanceID = Disk.Bay.1:Enclosure.Internal.0-0:RAID.Slot.1-1 LastSystemInventoryTime = 20120116145459.000000+000 LastUpdateTime = 20120116145459.
PAGE 154
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 LastSystemInventoryTime = 20120116145459.000000+000 LastUpdateTime = 20120116145459.000000+000 LockStatus = 0 MediaType = 1 Name = Virtual Disk 00 ObjectStatus = 0 OperationName = None OperationPercentComplete = 0 PhysicalDiskIDs = Disk.Bay.0:Enclosure.Internal.0-0:RAID.Slot.1-1, Disk.Bay.1:Enclosure.Internal .0-0:RAID.Slot.1-1, Disk.Bay.2:Enclosure.Internal.0-0:RAID.Slot.
PAGE 155
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 StripeSize = 128 VirtualDiskTargetID = 0 WriteCachePolicy = 1 16.11 Listing the RAID EnclosureView Inventory Enumerating the EnclosureView, results in the attributes and inventory of the available enclosure components in the system. Enumerate EnclosureView with the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 156
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm i ResetConfig http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_RAIDService ?SystemCreationClassName=DCIM_ComputerSystem +CreationClassName=DCIM_RAIDService +SystemName=DCIM:ComputerSystem +Name=DCIM:RAIDService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:ResetConfig.xml The input file ResetConfig.
PAGE 157
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 If no foreign physical disks are available, the following message may result: ClearForeignConfig_OUTPUT Message = General failure MessageID = STOR006 ReturnValue = 2 16.14 Applying the Pending Values for RAID-CreateTargetedConfigJob() The CreateTargetedConfigJob() method is called to apply the pending values created by RAID methods. The system will automatically reboot depending on the ScheduledStartTime selected.
PAGE 158
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 OUTPUT: When this method is executed, a jobid or an error message is returned. The status of this jobid can be checked within the job control provider in Section 10. CreateTargetedConfigJob_OUTPUT Job Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.
PAGE 159
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 16.16 Managing Hot Spare 16.16.1 Determining Potential Disks-GetDHSDisks() The GetDHSDisks() method is used to determine possible choices of drives to be a dedicated HotSpare for the identified virtual disk. Invoke GetDHSDisks() with the following parameters and syntax: TARGET: This parameter is the FQDD of the target virtual disk. Its value will depend on the number of virtual disks, obtainable in Section 16.10.
PAGE 160
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 VirtualDiskArray: Array of ElementName(s) where each identifies a different VD, currently only one VD can be passed EXAMPLE: winrm i AssignSpare http://schemas.dmtf.
PAGE 161
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 16.16.3 Unassigning the Hot Spare-UnassignSpare() The UnassignSpare() method is used to unassign a physical disk. The physical disk may be used as a dedicated hot spare to a virtual disk, or as a global hot spare. After the method executes successfully the physical disk is no longer a hotspare.
PAGE 162
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 EXAMPLE: winrm i SetControllerKey http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_RAIDService ?SystemCreationClassName=DCIM_ComputerSystem +CreationClassName=DCIM_RAIDService +SystemName=DCIM:ComputerSystem +Name=DCIM:RAIDService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:SetControllerKey.xml The input file SetControllerKey.
PAGE 163
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 The input file LockVirtualDisk.xml is shown below: Disk.Virtual.0:RAID.Integrated.1-1 OUTPUT: This method requires an H700 or H800 controller to properly function, as does the LockVirtualDisk() method.
PAGE 164
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 EXAMPLE: winrm i EnableControllerEncryption http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_RAIDService?SystemCreationCl assName=DCIM_ComputerSystem +CreationClassName=DCIM_RAIDService +SystemName=DCIM:ComputerSystem +Name=DCIM:RAIDService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:EnableControllerEncryption.
PAGE 165
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 The special characters in the following set must be passed as mentioned below. &  & <  < >  > “  " ‘  ' Keyid: Key Identifier- Describes Key. The Keyid can be maximum 32 characters long and shoutd not have spaces in it.
PAGE 166
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 16.17.5 Removing the Key-RemoveControllerKey() The RemoveControllerKey() method is used to erase the key on the controller along with the attached encrypted drives. Invoke the RemoveControllerKey() method with the following parameters and syntax: TARGET: This parameter is the FQDD of the DCIM_ControllerView class. See section 16.1.
PAGE 167
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Include all protocols=0, Include SATA=1, Include SAStypes=2 DiskEncrypt: Types of encryption to include 0 = Include FDE capable and non encryption capable disks 1 = Include FDE disks only 2 = Include only non FDE disks PDArray: This parameter is the list of physical disk FQDDs EXAMPLE: winrm i GetRAIDLevels cimv2/root/dcim/DCIM_RAIDService ?SystemCreationClassName=DCIM_ComputerSystem +SystemName=DCIM:ComputerSystem +CreationClassName=DCI
PAGE 168
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 RAID 10 = 2048 RAID 50 = 8192 RAID 60 = 16384 16.18.2 Getting the Available Disks-GetAvailableDisks() The GetAvailableDisks() method is used to determine possible choices of drives to create virtual disks. Invoke GetAvailableDisks() with the following parameters and syntax: TARGET: This parameter is the FQDD of the DCIM_ControllerView (Section 16.
PAGE 169
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 OUTPUT: GetAvailableDisks_OUTPUT PDArray = Disk.Bay.0:Enclosure.Internal.0-0:RAID.Integrated.1-1, Disk.Bay.1:Enclosure.Internal.00:RAID.Integrated.1-1 ReturnValue = 0 16.18.3 Checking the Create VD Parameters Validity-CheckVDValues() The CheckVDValues() method is used to determine possible sizes of virtual disk as well default settings, given a RAID level and set of disks.
PAGE 170
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.
PAGE 171
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Size: Size of the virtual disk specified in MB. If not specified, default will use full size of physical disks selected. RAIDLevel: RAID 0 = 2 RAID 1 = 4 RAID 5 = 64 RAID 6 = 128 RAID 10 = 2048 RAID 50 = 8192 RAID 60 = 16384 SpanDepth: If not specified, default is single span which is used for RAID 0, 1, 5 and 6. Raid 10, 50 and 60 require a spandepth of at least 2.
PAGE 172
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows ReadPolicy: No Read Ahead = 16 Read Ahead = 32 Adaptive Read Ahead = 64 WritePolicy: Write Through = 1 Write Back = 2 Write Back Force = 4 DiskCachePolicy: Enabled = 512 Disabled = 1024 VirtualDiskName: Name of the virtual disk (1-15 character range) EXAMPLE: winrm i CreateVirtualDisk cimv2/root/dcim/DCIM_RAIDService ?SystemCreationClassName=DCIM_ComputerSystem +CreationClassName=DCIM_RAIDService +SystemName=DCIM:ComputerSystem +Name
PAGE 173
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.
PAGE 174
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Size, RAIDLevel, SpanDepth, SpanLength, StripeSize, ReadPolicy, WritePolicy, DiskCachePolicy, VirtualDiskName, Initialize VDPropValueArray: This parameter is the list of property values that is used to create a virtual Disk. The property values are for the property names listed under VDPropNameArray. Size: Size of the virtual disk specified in MB. If not specified, default will use full size of physical disks selected.
PAGE 175
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 256KB = 512 512KB = 1024 1MB = 2048 ReadPolicy: No Read Ahead = 16 Read Ahead = 32 Adaptive Read Ahead = 64 WritePolicy: Write Through = 1 Write Back = 2 Write Back Force = 4 DiskCachePolicy: Enabled = 512 Disabled = 1024 VirtualDiskName: Name of the virtual disk (1-15 character range) StartingLBA: Starting logical block address of virtual disks in blocks.
PAGE 176
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 +SystemName=DCIM:ComputerSystem +Name=DCIM:RAIDService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:CreateSlicedVirtualDisk.xml The input file CreateSlicedVirtualDisk.xml is shown below: RAID.Integrated.1-1 Disk.
PAGE 177
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Invoke CreateVirtualDisk() with the following parameters and syntax: TARGET: This parameter is the FQDD of the DCIM_ControllerView (Section 16.7) PDArray: This parameter is the list of physical disk FQDDs that is used to create a virtual Disk. VDPropNameArray: This parameter is the list of property names that is used to create a virtual disk.
PAGE 178
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 NewVirtualDisk Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.com/wbem/wscim/1/cim-schema/2/DCIM_VirtualDiskView SelectorSet Selector: InstanceID = DISK.Virtual.267386880:RAID.Integrated.1-1, __cimnamespace = root/dcim RebootRequired = YES ReturnValue = 0 16.18.
PAGE 179
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 16.19 Setting Controller Attributes 16.19.1 Changing the Value of a RAID Controller Enumeration Attribute The SetAttribute() method is used to set or change the value of a RAID controller or a virtual disk attribute. The example below shows setting a RAID controller enumeration attribute. To set a virtual disk attribute, use the FQDD of the virtual disk attribute for the Target, and the AttributeName and AttributeValue.
PAGE 180
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.
PAGE 181
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 EXAMPLE: winrm i SetAttribute cimv2/root/dcim/DCIM_RAIDSe rvice?SystemCreationClassName=DCIM_ComputerSystem+CreationClassName=DCIM_RAIDService+System Name=DCIM:ComputerSystem+Name=DCIM:RAIDService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic –file:SetAttribute_Integer_RAID_Controller.xml The input file SetAttribute_Integer_RAID_Controller.
PAGE 182
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 RAID.Integrated.
PAGE 183
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 16.21 Convert Physical Disks to Non RAID-ConvertToNonRAID() The ConvertToNonRAID() method is used to convert a physical disks in RAID state of “Ready” to a NonRAID state. After the method is successfully executed, the PendingValue property of RAIDPDState should reflect the pending changes.
PAGE 184
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Enumerating the BIOSEnumeration Class will display all BIOS attributes in a computer system. Enumerate BIOSEnumeration with the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 185
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 . 17.2 Getting a BIOS Enumeration Instance Getting one particular instance of the BIOSEnumeration, instead of all instances as shown in Section 17.1, is shown below. Get a BIOSEnumeration instance with the following parameters and syntax: [INSTANCEID]: This is obtained from the enumeration in Section 17.1, which shows an example using BIOS.Setup.1-1:NumLock as an instanceID EXAMPLE: winrm g http://schemas.dmtf.
PAGE 186
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 +SystemName=DCIM:ComputerSystem +Name=DCIM:BIOSService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:SetAttribute_BIOS.xml The input file SetAttribute_BIOS.xml is shown below: BIOS.Setup.
PAGE 187
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 BIOS.Setup.
PAGE 188
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 OUTPUT: DCIM_BIOSString AttributeName = OneTimeCustomBootStr CurrentValue = null DefaultValue = null FQDD = BIOS.Setup.1-1 InstanceID = BIOS.Setup.1-1:OneTimeCustomBootStr IsReadOnly = true MaxLength = 200 MinLength = 5 PendingValue = null DCIM_BIOSString AttributeName = UserLcdStr CurrentValue = null DefaultValue = null FQDD = BIOS.Setup.1-1 InstanceID = BIOS.Setup.
PAGE 189
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 2 = Graceful Reboot without forced shutdown 3 = Graceful reboot with forced shutdown Note: When a user does not want to set a reboot type when creating a target job, users should comment out the RebootJobType in the input xml. User should not enter “0” or give no parameter at all in the input xml. EXAMPLE: winrm i CreateTargetedConfigJob http://schemas.dmtf.
PAGE 190
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 the pending changes prior to CreateTargetedConfigJob() being called. After the configuration job is created, the pending changes can only be canceled by calling DeleteJobQueue() in the Job Control profile. Invoke CreateTargetedConfigJob() with the following parameters and syntax: Target: This parameter is the FQDD of the BIOSAttribute instances (from Section 17.
PAGE 191
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Target - Obtained from any BIOS enumerate WSMAN command PasswordType - Either 1 for system or 2 for setup OldPassword – Reference following XML case A), B) or C) NewPassword - Reference following XML case A), B) or C) EXAMPLE: winrm i ChangePassword http://schemas.dmtf.
PAGE 192
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 17.9.2 Version: 2.1.0 Create Target Configuration Job Create a configuration job as shown in Section 17.7. 17.9.3 Monitor Set BIOS Password Status To monitor the job status for setting the BIOS password, get the instance of the corresponding job as described within the job control provider in Section 10. Replace [INSTANCE ID] with the actual jobid from Section 17.9.1. EXAMPLE: winrm get http://schemas.dmtf.
PAGE 193
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm e cimv2/root/dcim/DCIM_BIOSPassword -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT: DCIM_BIOSPassword AttributeDisplayName = System Password AttributeName = SysPassword Dependency = Locked DisplayOrder = 1402 FQDD = BIOS.Setup.
PAGE 194
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 http://www.delltechcenter.com/page/DCIM.Library.Profile 18.1 Exporting Server Profile To backup host system server profile, invoke the BackupImage() method in the class DCIM_LCService. Backup feature gathers system information, firmware images, hardware configuration, Lifecycle Controller, iDRAC firmware, and configuration and stores the information in a file.
PAGE 195
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 NFS Share: ShareType is “0”. The entire “Passphrase="passphrase";” argument is optional. EXAMPLE: winrm i BackupImage http://schemas.dmtf.
PAGE 196
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows In-Correct Example: Version: 2.1.0 ShareName=”/folder1/subfolder”;ImageName=”image_name” OUTPUT: BackupImage_OUTPUT Job Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.
PAGE 197
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 18.2 Version: 2.1.0 Importing Server Profile To restore host system server profile, invoke the RestoreImage() method in the class DCIM_LCService. Restore process restores the system information, firmware images, hardware configuration, Lifecycle Controller, iDRAC firmware, and configuration from the backup image file located on either iDRAC vFlash SD card or network share. [IP ADDRESS]: This is the IP address of the file server.
PAGE 198
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm i RestoreImage http://schemas.dmtf.
PAGE 199
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 OUTPUT: RestoreImage_OUTPUT Job Address = http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous ReferenceParameters ResourceURI = http://schemas.dell.com/wbem/wscim/1/cim-schema/2/DCIM_LifecycleJob SelectorSet Selector: InstanceID = JID_001293618214, __cimnamespace = root/dcim ReturnValue = 4096 The response contains a reference to the job class that will provide the status of the operation.
PAGE 200
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows  Version: 2.1.0 Completed-Restore process has completed with no issues 19 iDRAC Configuration This feature provides the ability to remotely list, get, and set the attributes on various monolithic and modular servers for the three Dell iDRAC classes through the command line.  DCIM_iDRACCardEnumeration (19.1)  DCIM_iDRACCardInteger (19.4)  DCIM_iDRACCardString (19.6) Profile and Associated MOFs: http://www.delltechcenter.
PAGE 201
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 AttributeDisplayName = Virtual Media Attached AttributeName = Attached CurrentValue = Detached DefaultValue = Detached Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = VirtualMedia GroupID = VirtualMedia.1 InstanceID = iDRAC.Embedded.1#VirtualMedia.
PAGE 202
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 EXAMPLE: winrm g http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_iDRACCardEnumeration ?InstanceID=[INSTANCE ID] -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman:443 -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT: DCIM_iDRACCardEnumeration AttributeDisplayName = Nic Enable AttributeName = Enable CurrentValue = Enabled DefaultValue = Enabled Dependency = null DisplayOrder = 0 FQDD = iDRAC.
PAGE 203
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows VirtualMedia.1 IPv4.1 Users.3 OUTPUT: DCIM_iDRACCardEnumeration AttributeDisplayName = Nic Enable AttributeName = Enable CurrentValue = Enabled DefaultValue = Enabled Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = NIC GroupID = NIC.1 InstanceID = iDRAC.Embedded.1#NIC.
PAGE 204
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 CurrentValue = Administrator DefaultValue = NoAccess Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = Users GroupID = Users.3 InstanceID = iDRAC.Embedded.1#Users.3#IpmiLanPrivilege IsReadOnly = false PossibleValues = User, Operator, Administrator, NoAccess 19.4 Applying the Attributes and Polling Job Completion 19.4.
PAGE 205
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 Enabled NIC.1#VLanEnable Disabled VirtualMedia.1#Attached Dettached IPv4.1#Enable Enabled IPv4.
PAGE 206
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 winrm g http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_LifecycleJob?InstanceID=[INSTANCE_ID] -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic The input parameter is the InstanceID from the output of the ApplyAttributes() method.
PAGE 207
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 IsReadOnly = false PossibleValues = Detached, Attached, Autoattach DCIM_iDRACCardEnumeration AttributeDisplayName = IPv4 Enable AttributeName = Enable CurrentValue = Enabled DefaultValue = Enabled Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = IPv4 GroupID = IPv4.1 InstanceID = iDRAC.Embedded.1#IPv4.
PAGE 208
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 FQDD = iDRAC.Embedded.1 GroupDisplayName = NIC GroupID = NIC.1 InstanceID = iDRAC.Embedded.1#NIC.1#VLanPriority IsReadOnly = false LowerBound = 0 UpperBound = 7 DCIM_iDRACCardInteger AttributeDisplayName = User Admin Privilege AttributeName = Privilege CurrentValue = 511 DefaultValue = 0 Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = Users GroupID = Users.3 InstanceID = iDRAC.Embedded.
PAGE 209
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 DCIM_iDRACCardInteger AttributeDisplayName = VLan Priority AttributeName = VLanPriority CurrentValue = 1 DefaultValue = 0 Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = NIC GroupID = NIC.1 InstanceID = iDRAC.Embedded.1#NIC.
PAGE 210
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 FQDD = iDRAC.Embedded.1 GroupDisplayName = NIC GroupID = NIC.1 InstanceID = iDRAC.Embedded.1#NIC.1#DNSRacName IsReadOnly = false MaxLength = 63 MinLength = 1 DCIM_iDRACCardString AttributeDisplayName = IP Address AttributeName = Address CurrentValue = 172.27.36.55 DefaultValue = 192.168.0.120 Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = IPv4 GroupID = IPv4.1 InstanceID = iDRAC.Embedded.
PAGE 211
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows -filter:"select * from DCIM_iDRACCardString WHERE GroupID='NIC.1'" The possible inputs for GroupID are: NIC.1 IPv4.1 Users.3 OUTPUT: DCIM_iDRACCardString AttributeDisplayName = DNS RAC Name AttributeName = DNSRacName CurrentValue = IDRAC DefaultValue Dependency = null DisplayOrder = 0 FQDD = iDRAC.Embedded.1 GroupDisplayName = NIC GroupID = NIC.1 InstanceID = iDRAC.Embedded.1#NIC.
PAGE 212
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 IsReadOnly = false MaxLength = 16 MinLength = 1 19.9 Changing the iDRAC IPChange Notification 19.9.1 Getting the Current iDRAC IPChange State Get the IPChangeNotifyPS attribute from the DCIM_LCAttribute class to display. The CurrentValue field indicates the current status of this attribute. EXAMPLE: winrm get http://schemas.dmtf.
PAGE 213
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 ?SystemCreationClassName=DCIM_ComputerSystem +CreationClassName=DCIM_LCService +SystemName=DCIM:ComputerSystem +Name=DCIM:LCService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic -file:setattribute.xml The input file setattribute.xml is shown below: PAGE 214
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 ?SystemCreationClassName=DCIM_ComputerSystem +CreationClassName=DCIM_LCService +SystemName=DCIM:ComputerSystem +Name=DCIM:LCService -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT: GetRemoteServicesAPIStatus_OUTPUT LCStatus = 0 Message = Lifecycle Controller Remote Services is ready.
PAGE 215
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows 5 (Lifecycle Controller Unified Server Configurator) LCStatus 0 (Ready) 1 (Not Initialized) 2 (Reloading Data) 3 (Disabled) 4 (In Recovery) 5 (In Use) 20.2 Version: 2.1.0 Server is executing UEFI Lifecycle Controller Unified Server Configurator application Lifecycle Controller instrumentation is up to date and enabled Lifecycle Controller instrumentation is not initialized. The initialization operation may take up to a minute.
PAGE 216
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 21 System Information The DCIM System Info Profile describes the properties and interfaces for executing system management tasks related to the management of the host system. The profile standardizes and aggregates the description for the platform’s basic properties into a system view representation and provides static methodology for the clients to query the system views without substantial traversal of the model.
PAGE 217
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 LicensingRollupStatus = 1 LifecycleControllerVersion = 2.0.0 Manufacturer = Dell Inc.
PAGE 218
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows winrm e "cimv2/root/dcim/DCIM_PSNumericSensor" -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNCheck -SkipCACheck -encoding:utf-8 -a:basic OUTPUT: DCIM_PSNumericSensor BaseUnits = 6 CreationClassName = DCIM_PSNumericSensor CurrentReading = 11 CurrentState = Normal Description = Power Supply Power Consumption DeviceID = iDRAC.Embedded.
PAGE 219
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.
PAGE 220
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT: DCIM_FCString AttributeDisplayName AttributeName = DeviceName CurrentValue = QLogic QLE2662 16Gb FC Adapter Dependency FQDD = FC.Slot.3-1 InstanceID = FC.Slot.3-1:DeviceName IsReadOnly = true MaxLength = 32 MinLength = 0 PendingValue ValueExpression . .
PAGE 221
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 FCRxSequences FCRxTotalFrames = 0 FCTxKBCount = 0 FCTxSequences FCTxTotalFrames = 0 FQDD = FC.Slot.2-1 InstanceID = FC.Slot.2-1 OSDriverState = 2 PortSpeed = 2 PortStatus = 3 DCIM_FCStatistics FCInvalidCRCs = 0 FCLinkFailures = 0 FCLossOfSignals = 0 FCRxKBCount = 0 FCRxSequences FCRxTotalFrames = 0 FCTxKBCount = 0 FCTxSequences FCTxTotalFrames = 0 FQDD = FC.Slot.2-2 InstanceID = FC.Slot.
PAGE 222
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 ValueExpression . . 23.4 Listing the FC Inventory-Integer Class Enumerate FCInteger class ith the following parameters and syntax: EXAMPLE: winrm e http://schemas.dmtf.
PAGE 223
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 PossibleValues = Disabled PossibleValues = Enabled PossibleValuesDescription . . 23.6 Changing the FC Attributes-SetAttribute() The SetAttribute() method can be used to change the FC configuration.
PAGE 224
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 the CreateTargetedConfigJob() jobID output with the job control section can be used to obtain its status. Invoke CreateTargetedConfigJob() with the following parameters and syntax: TARGET: This Parameter is the FQDD of the instances, obtained from the InstanceID field RebootJobType: There are three options for rebooting the system.
PAGE 225
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows Version: 2.1.0 ResourceURI = http://schemas.dell.com/wbem /wscim/1/cim-schema/2/DCIM_LifecycleJob SelectorSet Selector: InstanceID = JID_001269609760, __cimnamespace = root/dcim ReturnValue = 4096 23.8 Deleting the Pending Values for FC-DeletePendingConfiguration() This method is called to cancel the pending values created by the SetAttribute() and SetAttributes() methods.
PAGE 226
Dell™ Lifecycle Controller 2 Web Services Interface Guide for Windows -u:[USER] -p:[PASSWORD] -r:https://[IPADDRESS]/wsman -SkipCNcheck -SkipCAcheck -encoding:utf-8 -a:basic OUTPUT: DCIM_FCView Bus = 5 ChipType = 8324, Rev. 01 Device = 0 DeviceName = QLogic QLE2662 16Gb FC Adapter - 2001000E1E099026 EFIVersion = 5.30 FCTapeEnable = 3 FQDD = FC.Slot.3-1 FabricLoginRetryCount = 0 FabricLoginTimeout = 0 FamilyVersion = 02.00.