White paper irmc Redfish API

Size: px

Start display at page:

Download "White paper irmc Redfish API"

Poppy McGee
6 years ago
Views:

1 White paper irmc Redfish API This document shows a brief overview how to use Redfish API on irmc. Content Introduction 2 Prerequisites 2 RESTful/Redfish API general structure 2 RESTful curl-usage examples 4 GET 4 PATCH 5 POST create 5 POST action 6 DELETE 6 RESTful Postman usage example 7 GET 7 PATCH 7 POST create 8 POST action 9 DELETE 9 Page 1 of 9

2 Introduction The Redfish Scalable Platforms Management API (Redfish) is a new specification that uses a RESTful interface to access the data defined in a data model. The main purpose of such an approach is the necessity of efficient and secure out-of-band system management in terms of growing scale and complexity of data center infrastructure. The standard was published by Distributed Management Task Force (DMTF) which creates open manageability standards spanning over diverse emerging and traditional IT infrastructures. Fujitsu PRIMERGY Servers with irmcs5 firmware implement the standard and this document provides a first look into how to take advantage of this in regards of scripting the configuration. To learn more about Redfish and find the latest Redfish Specifications: Prerequisites This document assumes that the reader is familiar with the RESTful web services, JSON and HTTP in general. To learn more about REST API and JSON see the following links: To access Redfish API you also need a Fujitsu PRIMERGY Server with irmcs5. For most content the client is not requested to have any licenses available. RESTful/Redfish API general structure The basic principle behind this API is the mapping of the HTTP operations to the basic CRUD (create, read, update & delete) operations to the resources which are exposed by their URI (e.g. - the resource here would be Redfish ServiceRoot). The mapping looks as follows in table below. HTTP operation GET PATCH POST DELETE CRUD operation Read the resource Update resource partially. Here the If-Match Request Header must specify a valid Etag for the resource. Creates a new resources or starts an action Deletes the resource Each of these HTTP operations delivers an HTTP return code which informs the client whether the request was successful or failed for some reason. Additionally, you may get a return payload depending on the resource, which is described in the specification of this interface. The return codes are commonly known and described in web-accessed RFC. The supported HTTP operations of each Redfish resource are returned on a GET request to the resource in the HTTP Allow response header information. To ensure that only priviledged users have access to a particular resource almost every HTTP operation must be authenticated either with HTTP Basic/Digest authentication or session-based authentication. Exceptions regarding resources available without authentication are clearly described by Redfish specification. The irmc supports Content-Type application/json; charset=utf-8 on all resources; exceptions are described in the Redfish Specification. Redfish is designed as a hypermedia API. Page 2 of 9

3 Like other hypermedia APIs, Redfish has a single service endpoint URI and all other resources are accessible via opaque URIs referenced from the root. Any resource discovered through links found by accessing the root service or any service or resource referenced using references from the root service will conform to the same versions of the protocols supported by the root service 1. The service root is accessed by The Redfish implementation is accessible by HTTPS only. 1 Redfish Scalable Platforms Management API Specification, DSP0266_1.0.5, Section 5.5.5, DMTF, Page 3 of 9

4 RESTful curl-usage examples In the following examples we use curl for the HTTP requests. See: GET curl -u admin:admin -k -H "Accept: application/json" -X GET -i " HTTP/ OK Allow:GET/PATCH ETag: Date: Fri, 17 Mar :43:21 GMT Expires: Thu, 16 Mar :43:21 GMT Content-Length: 1086 { "@odata.context":"\/redfish\/v1\/$metadata#accountservice(oem,id,name,status,serviceenabled,authfailureloggingthreshold,minpasswordle ngth,maxpasswordlength,accountlockoutthreshold,accountlockoutduration,accountlockoutcounterresetafter,accounts,roles)", "@odata.id":"\/redfish\/v1\/accountservice", "@odata.type":"#accountservice.v1_0_3.accountservice", "Oem":{ "Id":"AccountService", "Name":"Account Service", "Status":{ "State":"Enabled", "Health":"OK", "Oem":{ } "ServiceEnabled":true, "AuthFailureLoggingThreshold":1, "MinPasswordLength":1, "MaxPasswordLength":20, "AccountLockoutThreshold":5, "AccountLockoutDuration":30, "AccountLockoutCounterResetAfter":30, "Accounts":{ "@odata.id":"\/redfish\/v1\/accountservice\/accounts" "Roles":{ "@odata.id":"\/redfish\/v1\/accountservice\/roles" "@Redfish.Copyright":"Copyright Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see "@odata.etag":" " } Page 4 of 9

5 PATCH curl -u admin:admin -H "Content-type: application/json" -H "If-Match: " -k -d '{"AlertChassisEvents":false}' -X PATCH -i " <ip-addr>/redfish/v1/managers/irmc/oem/ts_fujitsu/irmcconfiguration/ " HTTP/ OK ETag: Date: Fri, 17 Mar :44:58 GMT Expires: Thu, 16 Mar :44:58 GMT Content-Length: 862 { "@odata.context":"\/redfish\/v1\/$metadata#managers\/members\/irmc\/oem\/ts_fujitsu\/irmcconfiguration\/ (name,itscountrycode,its CustomerId,AlertChassisEvents,AttachScreenshotEnabled,From,Subject,Message,AdminName,AdminPhone,ServerUrl,PagingEnabled)", "@odata.id":"\/redfish\/v1\/managers\/irmc\/oem\/ts_fujitsu\/irmcconfiguration\/ ", "@odata.type":"#ftsirmcconfiguration.v1_0_0.fts ", "Name":" Configuration", "ITSCountryCode":"", "ITSCustomerId":"", "AlertChassisEvents":false, "AttachScreenshotEnabled":false, "From":"MailFrom@domain.com", "Subject":"FixedMailSubject", "Message":"FixedMailMessage", "AdminName":"ITS_UserInfo0", "AdminPhone":"ITS_UserInfo1", "ServerUrl":" "PagingEnabled":false, "@Redfish.Copyright":"", "@odata.etag":" " } POST create curl -u admin:admin -H "Content-type: application/json" -k -d '{"UserName":"admin","Password":"admin"}' -X POST -i " HTTP/ Created ETag: Location:/redfish/v1/SessionService/Sessions/1 X-Auth-Token:xAdPdog85pjQ83HB Date: Tue, 21 Mar :43:04 GMT Expires: Mon, 20 Mar :43:04 GMT Content-Length: 521 { "@odata.context":"\/redfish\/v1\/$metadata#sessionservice\/sessions\/$entity(oem,id,name,username,password)", "@odata.id":"\/redfish\/v1\/sessionservice\/sessions\/1", Page 5 of 9

6 "Oem":{ "Id":"1", "Name":"Session", "UserName":"admin", "Password":null, Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see } POST action curl -u admin:admin -k -H "Content-type: multipart/form-data" -H "Accept: application/json" -X POST -F -i " HTTP/ No Content Date: Fri, 17 Mar :48:26 GMT Expires: Thu, 16 Mar :48:26 GMT Transfer-Encoding: chunked DELETE curl -u admin:admin -H "Accept: application/json" -k -X DELETE -i " HTTP/ OK Date: Fri, 17 Mar :47:03 GMT Expires: Thu, 16 Mar :47:03 GMT Transfer-Encoding: chunked Page 6 of 9

7 RESTful Postman usage examples In the following examples we use Postman client tool for the HTTP requests. See: GET PATCH Page 7 of 9

8 POST create Page 8 of 9

9 POST action DELETE Page 9 of 9

Black Box DCX3000 / DCX1000 Using the API

Black Box DCX3000 / DCX1000 Using the API updated 2/22/2017 This document will give you a brief overview of how to access the DCX3000 / DCX1000 API and how you can interact with it using an online tool.