Go to main content

Oracle® ILOM Web Service REST API

Exit Print View

Updated: December 2019
 
 

Prerequisites

Before using the Oracle ILOM REST API, consider the following information:

  • Required Oracle ILOM Firmware

    The Oracle ILOM REST API is available on servers running Oracle ILOM firmware version 4.0 or later.

  • Required SSL Certificate

    Oracle ILOM managed devices should be properly configured with a valid Web Server SSL Certificate (default provided self-signed or user installed CA signed). For further information about configuring and validating an SSL Certificate, see Improve Security by Using a Trusted SSL Certificate and Private Key in Oracle ILOM Security Guide For Firmware Releases 3.x and 4.x

  • Use of REST API Development Tools With Client Examples

    To access the Oracle ILOM REST API, you can use any tool or programming library that can generate HTTP requests. For instance, the following tools can access the REST API in various capacities:

    • cURL – cURL is a command-line tool and library for transferring data using URL syntax. cURL is an open source software product that is available for download from http://curl.haxx.se/


      Note -  This guide includes a mix of HTTP request examples and cURL based examples. The purpose of these examples is to demonstate the syntax for creating client requests and then showing the applicable server responses.
    • Web Browser With the Postman REST Client Plug-in Extension – A web browser with REST client plug-in extension enables you to retrieve the REST API data. However, it does not support modifying the REST API data.

    • Java and Python HTTP Libraries – Languages such as Java and Python include HTTP libraries that you can use to interact with the REST application. To help users get started with using the Oracle ILOM REST API, client code samples for Java and Python are provided. See Appendix: Java Code Usage Sample for Oracle ILOM REST API Client and Appendix: Python Code Authentication Samples for Oracle ILOM REST API Client.

    • Swagger UI tool – The Swagger UI is a user interface tool that enables you to view the REST API descriptions, as well as to modify the REST API data. You can download the Swagger UI tool from the swagger home page ( http://swagger.io). For further details, see Appendix: Using Swagger UI to Access Oracle ILOM Web Service REST API.