Concept Guide

XML schema description

An XML schema (also known as XSD) is a description of a type of XML document, typically expressed in terms of constraints on the

structure and content of documents of that type, above and beyond the basic syntactical constraints imposed by XML itself. These

constraints are generally expressed using some combination of grammatical rules governing the order of elements.

NOTE: To access the XSD, use the link en.community.dell.com/dell-groups/dtcmedia/m/mediagallery/

Web services interface guide

The web Services Interface Guide (WSIG) serves as a guideline for utilizing the functionality available from embedded Lifecycle Controller

Remote Services web Services interfaces. It provides information and examples for utilizing the web services for WSMAN protocol using

Windows WinRM and open source WSMANCLI command-line utilities.

• Windows Version —en.community.dell.com/techcenter/extras/m/white_papers/20438393

• Windows batch file examples —en.community.dell.com/techcenter/extras/m/white_papers/20066179.aspx

• Linux Version —en.community.dell.com/techcenter/extras/m/white_papers/20438394.aspx

• Linux WSMAN shell script examples —http://en.community.dell.com/techcenter/extras/m/white_papers/20066181.aspx

WSMAN Best practices guide

The Best Practices Guide provides the work flows that group smaller WSMAN operations to achieve a particular task. To access the Best

Practices Guide, from the Dell TechCenter (www.delltechcenter.com/lc) page, under the Web Services Integration Tools, click Best

Practices Guide. Alternatively, go to en.community.dell.com/techcenter/extras/m/white_papers/20066173.aspx

Sample scripts corresponding to all sections in the document are also provided, using WinRM on Windows and wsman cli on Linux.

The Best Practice Guide contains the detailed instructions of common work flows to perform various tasks utilizing WinRM or WSMAN.

The PYTHON scripting language is used to provide a software development kit (SDK) for the Lifecycle Controller API methods. The

following primary objectives are addressed through the SDK:

• Work flows documented in the Best Practices Guide provide guidance to established, known, and working API methodologies.

• The corresponding PYTHON sample scripts are separately provided. After invoking these scripts, the output log can be used to

provide approximate timing on a particular system configuration, and raw WinRM or Open-WSMAN input and output.

NOTE: The scripts are located here — en.community.dell.com/techcenter/extras/m/white_papers/20066173.aspx

Attribute registry XML

The attribute registry lists all the attributes and properties for the particular component in XML format. For attribute registries of RAID,

NIC, iDRAC, BIOS, FC HBA, and PCIeSSD, see en.community.dell.com/dell-groups/dtcmedia/m/mediagallery/20440476.

Event message registry XML

The message registry XML describes all messages, message IDs, and message arguments from all profiles.

This zipped file contains the iDRAC and Lifecycle Controller event and error message data in XML, conforming to the DMTF DSP0228

message registry XML schema. The zipped file also includes an XSL file provided by Dell that enables content searching and reading easier.

To view the Dell Event Message Reference Guide document, go to en.community.dell.com/techcenter/systems-management/w/wiki/

lifecycle-controller#attributereg and click the latest OpenManage Software version. The Event Message Reference document contains

the error and event information generated by firmware and other agents that monitor system components. These events are logged and

displayed to the user on one of the system management consoles, or both logged and displayed.

XML schemas

The Lifecycle Controller XML Schema Guide provides interpretation of XML used by the Lifecycle Controller to describe various Lifecycle

Controller output XML content such as:

• Logs

• Configuration results

• Hardware Inventory

Getting started with API collateral and links