Dell PowerEdge R740xd2 Lifecycle Controller Version Remote Services Quick Star - Page 9

3 Getting started with API collateral and links Perform the following steps to start using the Lifecycle Controller API: 1. Identify the feature or the required management operation. 2. Determine how the API is constructed for the required management activity. 3. Utilize a client to access the API. 4. Use the best practices work flows for the client to interact with the API to accomplish the activity. Topics: • WSMAN Profiles • WSMAN MOF WSDL and XSD API definitions • Web services interface guide • Attribute registry XML • Event message registry XML • XML schemas • iDRAC RESTful API with Redfish • Authorization and licensing requirements for API access WSMAN Profiles Profiles describe the behavior of each feature and necessary classes, properties, methods, and configurable management attributes that represent the feature. The Profile documents explain the features that are supported in the Lifecycle Controller-Remote Services provided within the context of the CIM architecture. Profile specifications are organized around different management areas or domains. WSMAN MOF WSDL and XSD API definitions A complement to the profile documentation is the Managed Object File (MOF) that documents the implementation of the Dell-specific CIM classes. Web Service Description Language (WSDL) and XML Schema Definition (XSD) files describe the resulting functionality. 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. To access WSIGs for Microsoft Windows and Linux with scripting examples, see API Integration Guides section at www.dell.com/ support/article/sln311809. 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 Attribute Registry document in Manuals and Documents section of Documentation. 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 that helps to search the content easily. Getting started with API collateral and links 9