Redfish iRMC S5 - Fujitsumanuals.ts.fujitsu.com/file/13377/irmc-redfish-spec-en.pdf · The API document applies for iRMC S5 systems ... Snippet 1 Example WebServer to Redfish Service

Page 1 of 45

Specification iRMC Redfish API iRMC FW 1.2x

1/30/2018 Copyright © FUJITSU LIMITED 2018 All rights reserved

Designations used in this document may be trademarks, the use of which by third parties for their own purposes could violate the rights of the

trademark owners

All rights reserved, including intellectual property rights. Technical data subject to modifications and delivery subject to availability. Any liability that the data and illustrations are complete, actual or correct is excluded. Designations may be trademarks and/ or copyrights of the respective manufacturer, the use of which by third parties for their own purposes may infringe the rights of such owner. For further information see ts.fujitsu.com/terms_of_use.html © Copyright FUJITSU LIMITED 2017

Page 2 of 45

Contents

1. Foundations 3 1.1 Overview 3 1.2 Architecture overview 3 1.3 WebServer – Redfish processes API 4 1.4 FTS WebServer usage 4 1.5 Authentication 5 1.6 Redfish service – required HTTP headers 5 1.7 HTTPS with Redfish 5 1.8 Replacement patterns - Generic Map 5 1.9 Resource 8 1.10 Resource Tree 10 1.11 Multiple Resource Identifier concept 12 2. Implementation 14 2.1 Logging 14 2.2 Event handling 14 2.3 Error handling – extended messages 14 2.4 Account Service 15 2.5 Actions 16 2.6 Task Service 18 2.7 Resource tree specification 20 3. Example Redfish requests 44 4. Contents 45

Page 3 of 45

1. Foundations

1.1 Overview

The API document applies for iRMC S5 systems with FW version 1.2x.

1.2 Architecture overview

Architecture overview presented in Figure 1.

The presented implementation is split across two processes and three libraries: - FTS_WebServer – an already existing WebServer process, which delivers HTTP protocol support and is responsible for

redirecting Redfish related requests to the Redfish Service process; - FTS_RedfishService – a new process that is responsible for handling communication with the WebServer (support for

authentication and licensing) and delivering support for DMAccessAPI delivered by DataModel; - libfts_RedfishServiceHelpers – a library with e.g. POSIX socket communication helpers, HTTP headers and authentication

support methods etc.;

service – HTTP server

FTS_WebServer

FTS_RedfishService

service

Redfish Data Model

library

Redfish Backend

library

RedfishServiceHelpers

library

GenericMap

ConvertAPI

• ConvertAPI between Redfish – Back-end values

• Unified access to iRMCBackend ( IPMI, CS, SCCI...)

• Unified declaration of Replacement patterns used in DataModel

Redfish request

UDS comm

• Handles HTTP redfish request

• Handles authorization and privileges

• Handles socket communication with WebServer DMAPI

GET, PATCH, POST, DELETE

ResourceTree

filesystem definition -relation between uri and resource + configuration

Resource definitionsWith replacement

patterns for values read from backend

Schema files

DMConvertAPI

Data Model Instance• File System • Path as URI• Resource Instance .json

files

Interpreter• Logic to create/

update resources• Cyclic/Event-based/

onDemand update

• Event-based notification mechanism (e.g. about changed CSV, statuschanges)

Event Handler

FTS_RedfishTaskMngr

service

Handling Redfish tasks(e.g. FW/Bios update, eLCM)

RedfishTaskMngrClienthelpers

library

UDS comm

Figure 1 Architecture overview

Page 4 of 45

- libfts_RedfishDataModel – a library containing resource definition files, ResourceTree and schema files and the logic to create and update the resource file structure on filesystem;

- libfts_RedfishBackend – a library containing logic to access specific API’s (IPMI, ConfigSpace, SCCI), containing support for replacement pattern handling (convertAPI), GenericMap and event handling.

- FTS_RedfishTaskMngr – a new process responsible for handling Redfish tasks - libfts_RedfishTaskMngrClient – a communication library for delivering communication API required for handling Redfish

tasks.

1.3 WebServer – Redfish processes API

Bi-directional inter-process communication plays a critical role in how well the feature performes. To reduce computational effort on both processes, a protocol based on Unix Domain Sockets (UDS) was implemented.

All messages between the WebServer and the Redfish Service are exchanged based on frames the structure of which is presented in Table 1. The length of messages exchanged between these two processes is hard to predict (e.g. profile management requires a long profile file transmission while a simple GET request does not contain an HTTP body) therefore setting a frame size to a large length could be inefficient. Frame size is configurable at the code level and by default set to 1500 characters. The biggest part of a frame is taken by data bytes structurized in JSON format for simplified handling. Because the authentication of Redfish related requests and header handling is performed by the Redfish Service, the whole received HTTP header must be passed to the Redfish Service.

Because the WebServer and the Redfish Service processes play both the receiver and the transmitter role, communication is handled exactly as follows:

Receiver mode – all frames are continuously being joined together unless the process has recognized the end of the transmission (in most situations a single frame should be enough). Then, the received message is validated against the expected and received data lengths. The analysis of received data starts;

Transmitter mode – the expected data to be sent is split into frames based on the available space in a single frame and the remaining number of bytes and finally sent one by one to the receiver.

The only difference between the exchanged messages is the internal format of the data bytes.

Table 1 Redfish-WebServer interprocess socket-based protocol description

Byte 0 Byte 1 Byte 2 Byte 3 Byte 4 - n

Transmission

continues

Expected data length to

transmit (high byte)

Expected data length to

transmit (low byte)

Transmission

package id

Data bytes in JSON format

Snippet 1 Example WebServer to Redfish Service message data bytes structure

{

"RedfishReq":

{

"ClientIpAddr":"10.11.12.13",

"HttpHeaderLen":325,

"HttpHeader":"Accept: application/json",

"HttpBody":"{"Name":"UsrName1"}"

}

}

Snippet 2 Example Redfish to WebServer message data bytes structure

{

"RedfishResp":

{

"RespRetCode":201,

"RespMime":21,

"RespHeader":"Location: /redfish/v1/AccountService/Accounts/4",

"RespBody":"{"Name":"UsrName1"}"

}

}

1.4 FTS WebServer usage

A significant effort was put by developers into not making the Redfish implementation significantly dependant on the existing FTS_WebServer process to facilitate a future HTTP server replacement. However, to support required functionalities, some adjustements had to be made and therefore the Redfish process cannot operate without an FTS_Webserver now.

Page 5 of 45

1.5 Authentication

Implementation compliant with Redfish specification.

Depending on the sensitivity of a given resource, Redfish clients are required to authenticate their access. Fujitsu iRMC implementation supports either local credentials or any of the other supported authentication methods, such as LDAP and Active Directory. Authentication is achieved using a subset of the common HTTP headers supported by a Redfish service.

The Redfish Service implementation provides access to Redfish URI’s using two methods: - Basic authentication – user name and password must be provided with every request; - Session-based authentication – this method is recommended to be used when issuing multiple Redfish operation

requests. Authentication is performed only once when creating a session.

1.6 Redfish service – required HTTP headers

All supported request and response HTTP headers are compliant with Redfish specification and the user should be aware that some of them may not be returned under specific circumstances.

Cache-control handling: implementation supports cache-control header with no-cache for all of the resources.

Table 2 Supported HTTP headers

HTTP request headers HTTP response headers

Accept Allow

Content-Type Content-Type

OData-Version OData-Version

Authorization Location

If-Match Cache-Control

If-None-Match Access-Control-Allow-Origin

Origin WWW-Authenticate

Host X-Auth-Token

Link

1.7 HTTPS with Redfish

The Redfish implementation is compliant with Redfish specification in area of HTTPS handling, what means that interface user must use HTTPS connections for all Basic authenticated requests.

1.8 Replacement patterns - Generic Map

One of the most severe problems when designing the project architecture was to provide a common and standardized handler for properties retrieved and set via different backend API’s such as IPMI, Config Space, SCCI or FRU. The handler should use a single input, delivering all required sets of information to deal with differences between Redfish and specific backend values. The idea of a Generic Map and replacement patterns comes from these requirements.

The Generic Map file is a human readable JSON-formatted file that contains the definitions of replacement patterns. Replacement patterns are specifally formatted strings, which can be easily found in a resource by using regular expressions. Every pattern mentioned in any resource must be present in the Generic Map to be convertible into a real value. Moreover, every pattern has to be compliant with the known structure for a specific backend API. For more details, please take a look into table below.

Table 3 GenericMap - replacement pattern properties description

Property name Property values Property values details Additional description

RefreshMode

(obligatory)

onInit A property value is refreshed only once during init

phase.

onDemand

A property value is refreshed on every request (the

appropriate entry in ResourceTree must point to the

related resource as RD).

onEvent A property value is updated based on a defined event.

DataSource

(obligatory) Get (optional) IPMI, CS, LCMDB, Function

An interface used during initialization/update.

If omitted, the value property is null (useful for

Page 6 of 45

passwords).

Set (optional) CS, Function An interface used while setting a value (POST/PATCH).

If omitted, the property is treated as read-only.

SourceParams

(obligatory)

Get (optional)

CS: id, oid, offset

IPMI: fn, cmd, data

LCMDB: GroupName, ParameterName, oid

Function: function, arg1, arg2, arg3 For every supported interface SourceParams must have

a specific structure.

Set (optional)

CS: id, oid, offset

Function: function, arg1, arg2, arg3

ConvertMethod

(obligatory)

Get (optional)

BackendDataType (obligatory) RedfishDataFormat (obligatory) RedfishDataType (obligatory)

BackendDataOffset (optional) BackendDataLength (optional) BackendDataMask (optional) Limitation (optional only for Set)

BackendDataType – specifies the format of the

backend value: lsb (binary data in LSB format), msb

(binary data in MSB format), bytestream (containing

string data).

RedfishDataType – specifies the format of a Redfish

property: hex, dec_unsigned, dec_signed, string,

datatime, datatimeOffset, systemUUID, ipv4address,

ipv6address, mapping

RedfishDataType – specifies the JSON object format of

a Redfish property

BackendDataOffset – offset of target data

BackendDataLength – length of target data

BackendDataMask – the mask of target data

Set (optional) Exactly the same as for Get beside:

Limitation Exactly the same as for Get aside from additional

Limitation property

DataMapping

(optional)

BkVal

RfVal

Define thes array of Backend into Redfish or vice versa

mapping if mapping was defined as RedfishDataType

in ConvertMethod.

UsedIn

(optional)

Defines the array of URI’s which must be updated

when the values change due to a received event.

Event

(optional)

Defines the event type which must trigger the resource

update.

The framework accepts only a limited set of convertion definitions between backend and the Redfish property values. The set was presented in Table 4 .

Table 4 GenericMap - accepted conversion definitions

RedfishDataType -->

BackendDataType

JSON bool JSON int JSON int64 JSON string Additional info

lsb, msb

mapping hex,

dec_unsigned,

dec_signed,

mapping

hex,

dec_unsigned,

dec_signed

hex,

dec_unsigned,

dec_signed,

mapping,

date_time,

time_offset

Offset, length and mask are taken into

account

bytestream

mapping NONE NONE string,

mapping,

ipv4,

ipv6,

sys_uuid

Mask – is not taken into account.

Format mapping: length and offset are taken

into account

Format string: length and offset are taken

into account

Format sys_uuid: only length is taken into

account

Format ipv4/ipv6: both length and offset are

Page 7 of 45

NOT taken into account (no situation that IP

address should be limited)

Due to the number of properties which have to be declared in a Generic Map file size is relatively big. Morever, on the one hand, the file format facilitates development, while on the other hand, it implies that conversion is needed from JSON format. To facilitate the logic required for efficient handling, one of the most efficient information retrieval data structures was used. This structure is called TRIE.

During initialization, the GenericMap file is converted only once into a JSON object and initial analysis begins. All defined replacement patterns are analyzed one by one and their names are saved in a TRIE node structure. Subsequently, the id of the pattern just analyzed from the other patterns in the Generic Map is used to save all required API details in the table as a specific index, which makes searching much easier and quicker. The logic which needs to access specific API defined by the replacement pattern, needs to search within TRIE, find the index and the access table in the memory without any time-consuming string comparisons. This means that the GenericMap file is used only during initialization. During the runtime execution the memory structures are used. The most significant drawback of that solution is the memory footprint, since all API access details must be saved. However, performance gain plays a significant role here.

An example TRIE node structure for a single @SEL_ID@ was presented in Figure 2.

Figure 2 An example TRIE node handling for an example replacement pattern

An example Generic Map file was presented in Snippet 3.

Snippet 3 An example GenericMap file replacement pattern definition

{ "GENERIC_MAP": { "@SERVERSERIALNUMBER_RO@": { "SourceParams": { "Get": { "id":"0x207" } }, "ConvertMethod": { "Get": { "BkDType":"bytestream", "RfDType":"string", "RfDFormat":"string" } }, "DataSource":

/0 id=23

Array of parameter structures

paramArray[0]

paramArray[1]

paramArray[2]

paramArray[numOfParams-1]

paramArray[3]

paramArray[...]

paramArray[23]

S

E

L

_

I

D

@

@

Page 8 of 45

{ "Get":"CS" }, "Event":"changeCsv", "RefreshMode":"onEvent", "UsedIn": [ "/redfish/v1/Chassis/$IDX$", "/redfish/v1/Systems/$IDX$" ] } }

1.9 Resource

The implementation described in the document distinguishes between two resource file types: resource definition and resource instance file. Both of them are human readable JSON-formatted files that contain a set of properties structurized to conform to a specific schema file. However, because the instance is created from the definition, the file contents is different.

The framework needs to know how to correlate a specific resource with backend API details. Therefore, a resource definition file, if it is related with dynamic backend data retrieval, contains some replacement patterns used by the framework to access the data. Since resource definition is not available for an iRMC user, its structure is optimized for framework logic and may be significantly different from what the reader could expect. Moreover, since one resource definition file may be used to create several instance files and some property values depend on that, a specific convention should be used. A good example could be user accounts, the structures of which are identical, so the definition is exactly the same.

For details about replacement patterns, please refer to chapter 1.8. For details about the MRI concept, please refer to chapter: 1.11.

Examples of resource definition files were presented in the snippets below. Please keep in mind that for some example-specific notation was used to simplify resource creation (e.g. ItemNext property for resource collections).

Snippet 4 Standard resource example

{ "@odata.context":"/redfish/v1/$metadata#Managers/Members/iRMC/iRMCConfiguration/Dns", "@odata.id":"/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Dns", "@odata.type":"#FTSiRMCConfiguration.v1_0_0.Dns", "Name":"DNS Configuration", "DnsServers": { "@odata.id":"/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Dns/DnsServers" }, "DnsName": { "NameExtension":"@BMCNAMEEXTENSION@", "AddSerialNumber":"@BMCADDSERIALNUMBER@", "AddExtension":"@BMCADDEXTENSION@", "UseIrmcNameInsteadOfHostName":"@BMCUSENETWORKNAME@", "IrmcName":"@BMCNETWORKNAME@", "RegisterDNS":"@BMCREGISTERDNS@" }, "Retries":"@BMCDNSRETRIES@", "Timeout":"@BMCDNSTIMEOUT@", "Enabled":"@BMCUSEDNS@", "UseDhcp":"@BMCOBTAINDNSFROMDHCP@", "Domain":"@BMCDNSDOMAIN@", "SearchPath":"@BMCDNSDOMAINSEARCHPATH@" }

Page 9 of 45

Snippet 5 Standard resource without replacement patterns

{ "@odata.context":"/redfish/v1/$metadata#AccountService/Roles", "@odata.id":"/redfish/v1/AccountService/Roles", "@odata.type":"#RoleCollection.RoleCollection", "Name":"Roles Collection", "Description":"A Collection of Roles.", "Members": [ { "@odata.id":"/redfish/v1/AccountService/Roles/Admin" }, { "@odata.id":"/redfish/v1/AccountService/Roles/Operator" }, { "@odata.id":"/redfish/v1/AccountService/Roles/ReadOnlyUser" } ], "[email protected]":3 }

Snippet 6 Resource collection with single MRI definition

{ "@odata.context":"/redfish/v1/$metadata#Managers/Members/iRMC/LogServices/Members/SystemEventLog/Entries", "@odata.id":"/redfish/v1/Managers/iRMC/LogServices/SystemEventLog/Entries", "@odata.type":"#LogEntryCollection.LogEntryCollection", "Name":"System Event Log Collection", "Description":"Collection of System Event Log entries for this system", "[email protected]":"SystemEventLog/Members", "Members": [ { "{{ItemField}}": { "ItemNext":"NEXT_SEL", "ItemData": { "@odata.id":"/redfish/v1/Managers/iRMC/LogServices/SystemEventLog/Entries/$IDX$" } } } ], "Oem":{} }

Snippet 7 Resource collection with multiple MRI definitions

{ "@odata.context":"/redfish/v1/$metadata#Systems/Members/$SYSTEM_ID$/Processors", "@odata.id":"/redfish/v1/Systems/$SYSTEM_ID$/Processors", "@odata.type":"#ProcessorCollection.ProcessorCollection", "Name":"Processors Collection", "Description":"A Collection of Processors.", "Members": [ { "{{ItemField}}": { "ItemNext":"NEXT_SYSTEM|NEXT_PROCESSOR", "ItemData": { "@odata.id":"/redfish/v1/Systems/$SYSTEM_ID$/Processors/$CPU_ID$" } } } ] }

Page 10 of 45

It’s worth mentioning that there are some properties which are appended automatically by the framework and are not a part of the resource definition file. These properties were listed in Table 5.

Table 5 Resource properties appended by framework

Property name Description

[email protected]

Valid only for resource collection which contains the Members property as an array of

link(s) to all related resources. To facilitate resource collection, handling the number

of appended members is used to append this property.

@odata.etag The property is automatically appended only to the resource.

Resource collections are currently not supported.

@Redfish.Copyright The property is automatically appended to every resource (also to resource collection)

1.10 Resource Tree

The Resource Tree specifies the creation of the resource tree instance, so it tells how files must be organized in a runtime. For that reason, it plays a critical role during file system creation and update. Because of the number of settings which are related to resources, a decision was made to store the file in JSON format. To guarantee the highest possible performance, the file is parsed and kept in memory during whole life of the Redfish process.

Every entry in the ResourceTree is a supported uri with a set of additional properties which were listed in Table 6.

Table 6 Resource Tree entry properties description

Property

name

Obligatory

status

Entry JSON

object type

Description

DefFile Yes JSON string Resource definition file name in iRMC.

Allow Yes JSON string

Set of allowed HTTP methods for the resource: GET, POST, PATCH, DELETE.

For resources containing settings (properties with read/write mode), PATCH should be

appended. For resources which are expected to be dynamically created (currently User

accounts and Redfish sessions), POST for related collection should be appended and

DELETE for the resource itself.

EntryType Yes JSON string

R – for a resource without onDemand properties,

RD – for a resource with onDemand properties,

C – for a resource collection

RR – for a resource fully recreated on request

CR – for a resource collection fully recreated on request

ItemNext

Yes, for

collections with

MRI

JSON string

ItemNext string is obligatory for a resource with MRI definition(s).

The content of the string for more than one MRI definition specified must be split

with a delimiter – the implementation only allows to use "|".

Moreover, the number of MRI definitions in an entry must correspond with the

ItemNext number of handlers, otherwise the creation is rejected. ItemNext content

(e.g. defined NEXT_USR) must be reflected in the appropriate backend handler(s) for

the property.

License No JSON string

License configuration required for access a particular resource.

List of allowed values:

“KVM”

“MEDIA”

“eLCM”

Privileges No JSON string

User privileges, Redfish Role – configuration required for resource which have a write

mode (for HTTP PATCH, PUT, DELETE or POST). If the property is omitted, the default

“Administrator” is used.

List of allowed values:

“A” – stands for the Administrator role, required to introduce a change in a resource.

Page 11 of 45

Since it’s the default value, it should not be used explicitly

“0” – The Operator role is sufficient to introduce a change into a resource (it means

that the Administrator can do it as well)

“R” – The ReadOnly role is sufficient to introduce a change into a resource (it means

that an Administrator or Operator can do it as well)

Developers must be aware that the ResourceTree file is not analysed against the existence of replacement patterns, so their usage is forbidden. An example ResourceTree file was presented in Snippet 8.

Snippet 8 ResourceTree example structure

{ "ResourceTree": { "/redfish/v1": { "DefFile":"ServiceRoot_def.json", "Allow":"GET", "EntryType":"R" }, "/redfish/v1/Systems": { "DefFile":"ComputerSystemCollection_def.json", "Allow":"GET", "EntryType":"C" }, "/redfish/v1/Systems/$IDX$": { "DefFile":"ComputerSystem_def.json", "Allow":"GET/POST/PATCH", "EntryType":"R", "ItemNext":"NEXT_SYSTEMS" }, "/redfish/v1/AccountService/Accounts": { "DefFile":"ManagerAccountCollection_def.json", "Allow":"GET/POST", "EntryType":"C" }, "/redfish/v1/AccountService/Accounts/$IDX$": { "DefFile":"ManagerAccount_def.json", "Allow":"GET/PATCH/DELETE", "EntryType":"R", "ItemNext":"NEXT_USR" }, "/redfish/v1/Managers/iRMC/LogServices/SystemEventLog/Entries/$IDX$": { "DefFile":"SelEntry_def.json", "Allow":"GET", "ItemNext":"NEXT_USR" }, "/redfish/v1/Systems/EthernetInterfaces/$ETH_ID$/VLANs/$VLAN_ID$": { "DefFile":"VLAN_def.json", "Allow":"GET", "ItemNext":"NEXT_ETH_IF|NEXT_VLAN_ID", "Privileges":"O" } } }

Page 12 of 45

1.11 Multiple Resource Identifier concept

The reason why the Multiple Resource Identifier (MRI) concept was created is the necessity of handling resources which have an identical structure but unique property values. A user account or a processor resource could serve as an example.

The concept introduces two notions: an MRI definition and an MRI index.

MRI definition – an easily distinguishable string pattern used inside of a URI or a specific property value that is a part of a resource definition file. The MRI definition must fulfill specific regular expression requirements: (\\$[[:upper:]_^/]{1,15}\\$);

MRI index – a single number that is easily distinguishable from the content uri/resource content. It also must fulfill the specific regular expression requirements: (/[[:digit:]]{1,5}) .

Initialization

During initialization the framework accesses a backend API first of all to retrieve sets of valid MRI indexes for a specific resource type (e.g. to specify which users are created in the system, so which user resource instances should be created) based on ItemNext ResourceTree property. Then, it tries to replace the MRI definition(s) found in the ResourceTree uri and/or inside of the resource definition file and creates resource instance files by accessing a backend API with specific MRI index(es) – e.g. a config space value may have more than one id and, in this case, a specific id is used to read a given property value.

To create all sets of resource instance files of a given type (e.g. user accounts) a single entry in the ResourceTree must be defined, a specific resource definition structure must be kept and a GenericMap must define the used replacement pattern appropriately to the MRI concept. The framework, by accessing the mentioned configuration, can deal with the whole creation process, which makes it very flexible and easily extensible. Moreover, the MRI definition number in a single uri is limited to 3, which covers all currently known complex resources.

For further details about how to define a MRI-based resource, please refer to chapter 1.9.

Request handling

While handling a user request (GET, PATCH, POST, DELETE…) the framework has to deal with the requested uri containing MRI indexes instead of definitions. In this case, the framework must be able to correlate the uri with an appropriate entry in the ResourceTree to access necessary information about the permitted entry methods, the resource type or the resource definition file name. The MRI indexes must be also retrieved from the requested uri to access a specific backend API during setup or value update.

The logic described above leads to the conclusion that the MRI definition and the MRI index are strongly correlated with each other and the framework has to efficiently deal with a bi-directional conversion between them.

An example MRI index structure for the user account setup was presented in Figure 3. In a system, 4 users are defined with id’s: 2, 3, 5 and 6. The MRI structure consists of 4 single-element MRI sets with the given id’s.

Figure 3 MRI structures for an example user account setup

Sets container

Sets number = 4

RedfishMRISet

Set size = 1

unsigned int *indexesSet

MRI index

2

RedfishMRISet


MRI index

3


MRI index

5


MRI index

6

MRI set [0]

MRI set [1]

MRI set [2]

MRI set [3]

RedfishMRISet

RedfishMRISet

Set size = 1

Set size = 1

Set size = 1

Page 13 of 45

An example MRI index structure for VLAN’s of a specific Ethernet Interface was presented in Figure 4.

In a system, 3 ethernet interfaces are available and every interface has a single VLAN configured. The MRI structure consists of 3 double-element MRI sets with given id’s.

Figure 4 MRI structures for an example VLAN configuration

RedfishMRISet

Set size = 2


MRI index

2

RedfishMRISet

Set size = 2


MRI index

Set size = 2


MRI indexRedfishMRISet

3

3 0

5 1

Sets container

Sets number = 3

MRI set [0]

MRI set [1]

MRI set [2]

Page 14 of 45

2. Implementation

2.1 Logging

The implementation creates the following logging files where useful information about the initialization phase and runtime details can be found.

- /var/LogFile.RedfishService – the file is always available and contains high-level messages from the init phase and runtime operations

- /var/LogFile.RedfishService_DEBUG – the file is available only for FW image builds with the DEBUG mode enabled. It contains a much more detailed information set about the Redfish Service process.

2.2 Event handling

For asynchronous resource handing, an event-triggered update functionality was implemented. The list of implemented events was presented in Table 7.

Table 7 List of supported internal events

Event type Description

SEL change Change or clearing SEL implies an update of the internal cache

and a resource(s) update

iEL change Change or clearing iEL implies an update of the internal cache

and a resource(s) update

CS change Every used CSVV change is followed by an event sent to the

Redfish Service to update the related resource(s)

Session change Every internal Redfish session change implies a session resource

update

2.3 Error handling – extended messages

The Fujitsu Redfish implementation is compliant with Redfish specification in regards to the error handling area. To access JSON extended error specification please check: http://kashyyyk.abg.fsc.net/confluence/display/SI/Extended+error+codes.

Aside from the officially available Extended message information set, some OEM messages were defined and described in Table 8.

Table 8 Fujitsu OEM extended messages

Extended message content Error message string Related HTTP error code (if

any)

ActionParameterValueNotInList The value %s for the parameter %s is not in the list of acceptable

values.

400

(Bad request)

QueryParameterNotSupported Query parameter %s is not supported 501

(Not implemented)

OutOfMemory The request failed due to lack of free memory. 500

(Internal Server Error)

AcceptNotSupported The response format that was accepted by the requester is not

supported by the target URI

406

(Not acceptable)

ContentTypeNotSupported The content type format of the body of the message is not

supported

415

(Unsupported media type)

PreconditionFailed %s 412

(Precondition failed)

ResourceUnavailable The requested URI does not refer to a valid resource. 404

(Not found)

BackendError Accessing property %s failed because of backend error. -

http://kashyyyk.abg.fsc.net/confluence/display/SI/Extended+error+codes

Page 15 of 45

PropertyValueLimitsExceeded The value %s for the property %s exceeds allowed range or size -

SessionCreationAuthFailure When attempting to establish a new session, the service received

an authorization error

401

(Unauthorized)

PasswordLengthLimitForSNMPv3Exceeded The user cannot be created because SNMPv3 password requires

minimum 8 characters

400

(Bad request)

NoLicense A valid license is required to access the requested resource 403

(Forbidden)

LastAdmin It is prohibited to modify or delete the last user account with a

Redfish Administrator role

409

(Conflict)

ActionDataMissing The action %s requires the data %s to be present in the request

body

400

(Bad request)

ActionRelatedFeatureUnavailable The feature related to the requested action is unavailable at the

moment

409

(Conflict)

ActionDataValidationFailure The data delivered with action could not be validated due to %s 400

(Bad request)

AISConnectionTestUnavailable Connection test for AIS Connect cannot be performed while AIS

Connect is online

409

(Conflict)

ActionParametersInsufficient The action %s requires the valid set of parameters %s to be

present in the request body.

400

(Bad request)

DeclaredDataNotPresent Service was notified with Content-type: multipart/form-data, but

no data is present in the request body.

400

(Bad request)

RequestedFileIsNotAvailable The action %s requested operation on file which does not exist. 404

(Not found)

BSPBRBackupNotAvailable Requested BSPBR backup content does not exist. 404

(Not found)

AISConnectDisclaimerNotAccepted AIS Connect disclaimer is not accepted 409

(Conflict)

VariableRelatedFeatureUnavailable The feature related to the %s is disabled at the moment 409

(Conflict)

SSLKeyCertComplianceCheckFailure The SSL Key and Certificate pair compliance check finished with

failure

500

(Internal Server Error)

2.4 Account Service

The Account Service allows configuration all users, also non Redfish users. OEM properties allow here configuration IPMI and iRMC specific permissions. To grant Redfish API access you need to configuration the Redfish Role. This is an additional privilege.

It’s worth mentioning that at least one user account with an Administrator privilege must be always defined to guarantee Redfish configuration possibilities. This one user can neither change its role nor be deleted. Moreover, OEM privileges are not supported.

The standard user “admin” gets by default the Redfish Role “Administrator”.

Following Roles are available:

Role Permissions

ReadOnly Can perform GET operations. Cannot perform PATCH, DELETE or POST operations. Exceptions

- PATCH own User Password is allowed - Can perform POST and DELETE on the following resources:

o /redfish/v1/SessionService/Sessions/$IDX$ (delete user Session) o /redfish/v1/SessionService/Sessions (create user session)

Operator Chas the same restrictions as defined for Role “ReadOnly”

Exceptions

- Can perform PATCH (change writable properties), POST (can call actions defined in this resource) on the following resources

o /redfish/v1/Chassis/$CHASSIS_ID$ o /redfish/v1/Systems/$SYSTEM_ID$

Page 16 of 45

o /redfish/v1/TaskService/Tasks/$IDX$ o /redfish/v1/Systems/$SYSTEM_ID$/Bios

Administrator No restrictions

Please be aware that a WebUI user acts as a Redfish User.

For Redfish/UI users the Redfish Roles determine the permissions. So IPMI Privileges are not accounted in this use case.

Starting the AVR redirects to another Application. Here the specific AVR permissions are accounted. Logging in to the iRMC via an IPMI based interface the IPMI privileges are accounted and not the Redfish/UI roles.

The new WebUI supports this structure while separating the role and right permissions in different Tabs “Redfish/WebUI Permissions”, “IPMI Privileges”, “AVR Permissions” and “Other”.

2.5 Actions

Set of implemented actions is presented in Table 9.

Table 9 Actions specification

Action name Description FW

version Target link

FTSComputerSystem.

Reset

System reset – OEM

types 1.00u

/redfish/v1/Systems/$ID$/Actions/Oem/FTSComputerSystem.Reset

#ComputerSystem.

Reset

System reset 1.00u

/redfish/v1/Systems/$ID$/Actions/ComputerSystem.Reset

FTSChassis.FanTest Start fan test 1.00u /redfish/v1/Chassis/$ID$/Actions/Oem/FTSChassis.FanTest

#Manager.Reset iRMC reset 1.00u /redfish/v1/Managers/iRMC/Actions/Manager.Reset

#LogService.ClearLog Delete SEL log 1.00u

/redfish/v1/Managers/iRMC/LogServices/SystemEventLog/Actions/LogServ

ice.ClearLog

#LogService.ClearLog Delete IEL log 1.00u

/redfish/v1/Managers/iRMC/LogServices/InternalEventLog/Actions/LogSer

vice.ClearLog

FTSUser.

AddUserSSHKey

Upload user specific

SSHv2 key 1.01P

/redfish/v1/AccountService/Accounts/$IDX$/Oem/ts_fujitsu/Actions/Oem/

AddUserSSHKey

FTSUser.

RemoveUserSSHKey

Remove user specific

SSHv2 key 1.01P


RemoveUserSSHKey

FTSUser.

AddUserMIMECert

Upload user specific

S/MIME certificate 1.01P


AddUserMIMECert

FTSUser.

RemoveUserMIMECert

Remove user specific

S/MIME certificate 1.01P


RemoveUserMIMECert

FTSEventLog.

AddServiceNote

Add iEL entry service

note 1.01P

/redfish/v1/Managers/iRMC/LogServices/InternalEventLog/Actions/Oem/F

TSEventLog.AddServiceNote

FTSManager.

AddLicense

Upload license (e.g.

KVM, eLCM) 1.00u

/redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.AddLicense

FTSComputerSystem.

VirtualMedia

Connect Remote

Image 1.01P

/redfish/v1/Systems/$ID$/Actions/Oem/FTSComputerSystem.VirtualMedia

FTSManager. Restart Virtual Media 1.01P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.VirtualMediaServic

Page 17 of 45

VirtualMediaServiceRestart service eRestart

FTSComputerSystem.

DriverMonitorStatusReset

Reset Driver Monitor

status 1.01P

/redfish/v1/Systems/$ID$/Actions/Oem/FTSComputerSystem.DriverMonito

rStatusReset

FTSBios.BIOSUpdate Uploading and

flashing new

BIOS image

1.01P

/redfish/v1/Systems/$ID$/Bios/Actions/Oem/FTSBios.BIOSUpdate

FTSManager.

FWUpdate

Uploading and

flashing new

FW image

1.01P

/redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.FWUpdate

FTSAISConnect.

SendAnalysisFile

Trigger AISConnect to

send analysis file 1.01P

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/AISConnect

/Actions/FTSAISConnect.SendAnalysisFile

FTSAISConnect.

DisconnectRemoteSessions


disconnect remote

sessions

1.01P


/Actions/FTSAISConnect.DisconnectRemoteSesssions

FTSAISConnect.

ForcePoll


force poll 1.01P


/Actions/FTSAISConnect.ForcePoll

FTSManager.GetPowerHistory Gets the power history 1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.GetPowerHistory

FTSManager.GetCpuHistory Gets the CPU history 1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.GetCpuHistory

FTSManager.DeletePowerHistory Deletes/clears the

power history

1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.DeletePowerHistor

y

FTSManager.DeleteCpuHistory Deletes/clears the CPU

history

1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.DeleteCpuHistory

FTSManager.UpdateTimeFromNTP Update iRMC time

from NTP server (if

enabled and

configured)

1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.UpdateTimeFromN

TP

FTSComputerSystem.DriverMonitor

StatusReset

Resets Driver Monitor

status

1.03P /redfish/v1/Systems/0/Actions/Oem/FTSComputerSystem.DriverMonitorSta

tusReset

FTSAISConnect.TestConnection Trigger AISConnect

connection test

1.03P /redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/AISConnect

/Actions/FTSAISConnect.TestConnection

FTSManager.SaveCustomConfigura

tion

Save chosen iRMC

firmware settings in

ServerView® WinSCU

XML format

1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.SaveCustomConfig

uration

FTSManager.SaveFullConfiguration Save all iRMC firmware

settings in

ServerView® WinSCU

XML format

1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.SaveFullConfigurati

on

FTSManager.ImportConfiguration Import iRMC firmware

settings from file in

ServerView® WinSCU

XML format

1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.ImportConfiguratio

n

FTSLdap.TestLDAPAccess Test LDAP connection 1.03P /redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Ldap/Actio

ns/FTSLdap.TestLDAPAccess

FTSCertificate.UploadCACertificate Uploads iRMC CA

Certificate from file

1.03P /redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Certificates

/Actions/FTSCertificate.UploadCACertificate

FTSCertificate.UploadSSLCertOrKey SSL certificate file or

SSL key file


/Actions/FTSCertificate.UploadSSLCertOrKey

FTSCertificate.RestoreDefaultCACer

tificate

Restore CA certificate

to default one


/Actions/FTSCertificate.RestoreDefaultCACertificate

FTSCertificate.RestoreDefaultSSLCe

rtificate

Restore SSL certificate

and key to default

ones


/Actions/FTSCertificate.RestoreDefaultSSLCertificate

FTSCertificate.GenerateRSACertifica

te

Generate a new RSA

certificate


/Actions/FTSCertificate.GenerateRSACertificate

FTSUser.TestEmailConfig Test user email

configuration

1.03P /redfish/v1/AccountService/Accounts/$ID$/Actions/Oem/FTSUser.TestEmai

lConfig

FTSManager.FWTFTPUpdate Upload a new FW

image from TFTP

Server (configured in

1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.FWTFTPUpdate

Page 18 of 45

separate resource)

FTSBios.BiosTFTPUpdate Upload a new BIOS

image from TFTP

Server (configured in

separate resource)

1.03P /redfish/v1/Systems/$IDX$/Bios/Actions/Oem/FTSBios.BiosTFTPUpdate

FWTFTPTestWTFTPTest Test TFTP Server

settings and

connection

1.03P /redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.FWTFTPTest

FTSBios.BiosTFTPTest Test TFTP Server

settings and

connection

1.03P /redfish/v1/Systems/$IDX$/Bios/Actions/Oem/FTSBios.BiosTFTPTest

FTSBios.BSPBRRestore Restore BIOS Single

Paramaters from

ServerView WinSCU

XML format

1.03P /redfish/v1/Systems/0/Bios/Actions/Oem/FTSBios.BSPBRRestore

FTSBios.BSPBRBackup Trigger BSPBR backup 1.03P /redfish/v1/Systems/0/Bios/Actions/Oem/FTSBios.BSPBRBackup

FTSBios.BSPBRSaveBackupToFile Save BSPBR Backup to

file

1.03P /redfish/v1/Systems/0/Bios/Actions/Oem/FTSBios.BSPBRSaveBackupToFile

FTSTrapDestination.TestSNMPTrap Test trap destination

settings

1.03P /redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/NetworkSe

rvices/TrapDestinations/$IDX$/Actions/FTSTrapDestination.TestSNMPTrap

FTSPrimeCollect.TriggerArchiveGen

eration

Trigger PrimeCollect

archive generation

1.03P /redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/PrimeColle

ct/Actions/FTSPrimeCollect.TriggerArchiveGeneration

FTSPrimeCollect.DownloadArchive Trigger archive

download to user


ct/Actions/FTSPrimeCollect.DownloadArchive

FTSPrimeCollect.SetArchiveAsRefer

enced

Set archive as

referenced


ct/Actions/FTSPrimeCollect.SetArchiveAsReferenced

FTSAISConnect.AcceptEULA Accept AIS Connect

EULA


/Actions/FTSAISConnect.AcceptEULA

FTSAISConnect.ChangeAISState Change the AIS

Connect current state


/Actions/FTSAISConnect.ChangeAISState

FTSComputerSystem.DisableVIOM Disable VIOM 1.04P /redfish/v1/Systems/0/Actions/Oem/FTSComputerSystem.DisableVIOM

Bios.ResetBios Reset BIOS Settings 1.04P /redfish/v1/Systems/0/Bios/Actions/Bios.ResetBios

FTSComputerSystem.Screenshot Create/preview/save

and delete screenshot

of the OS console

1.04P /redfish/v1/Systems/0/Actions/Oem/FTSComputerSystem.Screenshot

FTSDns.ChangeDnsRecord Update or delete the

DNS record

1.05P /redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Dns/Action

s/FTSDns.ChangeDnsRecord

FTSMemory.ResetErrorCounter Reset the Error

Counter for the

selected DIMM

module

1.05P /redfish/v1/Systems/$SYSTEM_ID$/Memory/$DIMM_ID$/Actions/Oem/FTS

Memory.ResetErrorCounter

FTSSessionService.

DisconnectSession

Disconnect the

session defined by the

SessionId. Currently

only AVR sessions are

supported.

1.07P /redfish/v1/SessionService/Actions/Oem/FTSSessionService.DisconnectSes

sion

FTSCertificate.

VerifySSLCertKeyCompliance

Verify uploaded

certificates


FTSComputerSystem.

LogfileArchiveGenerate

Generate logfile

archive in zip format

1.22P /redfish/v1/Systems/0/Actions/Oem/FTSComputerSystem.LogfileArchiveGe

nerate

FTSComputerSystem.

LogfileArchiveDownload

Download generated

logfile archive

1.22P /redfish/v1/Systems/0/Actions/Oem/FTSComputerSystem.LogfileArchiveDo

wnload

2.6 Task Service

The Task service is used to describe the service that handles tasks. The implementation is compliant with Redfish specification.

The service contains a resource collection of zero or more task resources, which are used to describe a long running operation triggered by need of handling requests which take longer than a few seconds. Client is able to poll the task URI resource to determine operation status from a number of possible states.

http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSDns.ChangeDnsRecord

http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSMemory.ResetErrorCounter

http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSSessionService.DisconnectSession

http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSSessionService.DisconnectSession

Page 19 of 45

From implementation point of view Task service is implemented as separated process. Due to fact that Redfish Service process is responsible for handling all of upcoming requests interprocess communication between these two processes must be available and it bases on Unix Domain Socket (UDS).

Current implementation allows a single task to be executed, while other scheduled tasks are waiting in internal queue for execution. Finished task must be still accessible for its status availability. Task creation always is defined by action implementation.

Page 20 of 45

2.7 Resource tree specification

In Table 10 the complete supported Resource Tree was presented. For further details about the resources, please check the Confluence page: http://kashyyyk.abg.fsc.net/confluence/display/SI/FTS+Redfish+Data+Model?src=contextnavpagetreemode

Properties limitation concerns:

property missing in resource (property defined as nullable in schema): “Nullable, it won’t be supported”

property not supported at this moment (will be supported in future): “Not supported”

read/write mode limited to read-only: “Read-only limitation”

Link to an unsupported resource: “Link exists, but content not supported”

Resource exists but there is no functionality underneath: “Resource exists, but there is no functionality behind it (not supported)”

N/K – stands for not known limitations.

The reader of the document should be aware of different schema versions used for particular resources which is indicated by the resource @odata.type property.

Table 10 Complete supported Resource Tree with the description of limitations

Support URL

Licensed/

OEM

extended

Properties limitation (if any) Comment

/redfish no N/K

/redfish/v1

“@odata.type”: “FTSSchema.v1_0_0#ServiceRoot.v1_0_5.ServiceRoot"

Oem: "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.Vv1_0_0#FTSServiceRoot.v1_1_0.FTSServiceRoot "

no/yes

Description

Nullable, it

won’t be

supported

Links::Oem Not

supported

/redfish/v1/AccountService

“@odata.type”: “FTSSchema.v1_0_0# AccountService.v1_0_5.AccountService"

no/no

Description

Nullable, it

won’t be

supported

ServiceEnabled Read-only

limitation

/redfish/v1/AccountService/Accounts

“@odata.type”: “FTSSchema.v1_0_0#ManagerAccountCollection.ManagerAccountCollection "

no/no

Description

Nullable, it

won’t be

supported

http://kashyyyk.abg.fsc.net/confluence/display/SI/FTS+Redfish+Data+Model?src=contextnavpagetreemode

Page 21 of 45

/redfish/v1/AccountService/Accounts/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#ManagerAccount.v1_1_1.ManagerAccount"

Oem: "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSUser.v3_0_0.FTSUser"

no/yes

Locked

Not

supported

(no

functionality

behind the

property)

/redfish/v1/AccountService/Roles

“@odata.type”: “FTSSchema.v1_0_0#RoleCollection.RoleCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/AccountService/Roles/Administrator

“@odata.type”: “FTSSchema.v1_0_0#Role.v1_1_0.Role"

no/no

Description

Nullable, it

won’t be

supported

OemPrivileges Not

supported

/redfish/v1/AccountService/Roles/Operator


no/no

Description

Nullable, it

won’t be

supported

OemPrivileges Not

supported

/redfish/v1/AccountService/Roles/ReadOnly


no/no

Description

Nullable, it

won’t be

supported

OemPrivileges Not

supported

/redfish/v1/Chassis

“@odata.type”: “FTSSchema.v1_0_0#ChassisCollection.ChassisCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/Chassis/$CHASSIS_ID$

“@odata.type”: “FTSSchema.v1_0_0#Chassis.v1_0_5.Chassis"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSResourceExtension.v1_0_0.FTSChassis"

no/yes

Description

Nullable, it

won’t be

supported

SKU

Nullable, it

won’t be

supported

Links::Oem Not

supported

Links::ContainedBy Not

supported

Actions::#Chassis.Reset Not

supported

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus

FTSSchema.v1_0_0#FTSComponentStatusOverview.v1_0_0.FTSComponentStatusOverview

no/OEM N/K

http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSComponentStatusOverview.v1_0_0.FTSComponentStatusOverview

Page 22 of 45

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatusOverview

FTSSchema.v1_0_0# FTSComponentStatusCollectionOverview.v1_1_0.FTSComponentStatusCollectionOverview

no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/AmbientSensors

FTSSchema.v1_0_0#FTSComponentStatusCollection.FTSComponentStatusCollection

no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/AmbientSensors/$AMBIENT_IDX$

FTSSchema.v1_0_0#FTSComponentStatus.v1_1_0.FTSComponentStatus

no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/BatterySensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/BatterySensors/$BATTERY_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/CoolingSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/CoolingSensors/$COOLING_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/DriveSlotSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/DriveSlotSensors/$DRIVESLOT_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/MemorySensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/MemorySensors/$MEMORY_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/PCISlotSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/PCISlotSensors/$PCIE_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/PowerUnitSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/PowerUnitSensors/$POWERUNIT_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/ProcessorSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/ProcessorSensors/$CPU_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/PSUSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/PSUSensors/$PSU_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/SystemManagementModuleSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/t s_fujitsu/ComponentStatus/SystemManagementModuleSensors/$SYS_MODULE_IDX$


no/OEM N/K

http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSComponentStatusOverview.v1_0_0.FTSComponentStatusOverview

Page 23 of 45

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/SystemManagementSoftwareSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/SystemManagementSoftwareSensors/$SYS_SW_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/SystemSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/SystemSensors/$SYS_SENSOR_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/AddInCardSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/AddInCardSensors/$SYS_SENSOR_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/MiscSensors


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Oem/ts_fujitsu/ComponentStatus/MiscSensors/$SYS_SENSOR_IDX$


no/OEM N/K

/redfish/v1/Chassis/$CHASSIS_ID$/Power

“@odata.type”: “FTSSchema.v1_0_0#Power.v1_2_3.Power"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSResourceExtension.v1_1_0.FTSPower"

no/yes

Description

Nullable, it

won’t be

supported

PowerControl::PowerConsumedWatts

Nullable, it

won’t be

supported

[email protected] Not

supported

RelatedItem Empty array

object

Voltages::UpperThresholdNonCritical

Nullable, it

won’t be

supported

Voltages::UpperThresholdFatal

Nullable, it

won’t be

supported

Voltages::LowerThresholdNonCritical

Nullable, it

won’t be

supported

Voltages::LowerThresholdFatal

Nullable, it

won’t be

supported

Voltages::MinReadingRange

Nullable, it

won’t be

supported

Voltages::MaxReadingRange Nullable, it

Page 24 of 45

won’t be

supported

PowerSupplies::LineInputVoltageType

Nullable, it

won’t be

supported

PowerSupplies::LineInputVoltage

Nullable, it

won’t be

supported

PowerSupplies::PowerCapacityWatts

Nullable, it

won’t be

supported

PowerSupplies::LastPowerOutputWatts

Nullable, it

won’t be

supported

PowerSupplies::IndicatorLED

Nullable, it

won’t be

supported

PowerSupplies::SparePartNumber

Nullable, it

won’t be

supported

PowerSupplies::InputRanges::Oem Not

supported

PowerSupplies::[email protected]

Link exists,

but content

not

supported

PowerSupplies::RealtedItem Not

supported


supported


supported

Redudancy Not

supported

/redfish/v1/Chassis/$CHASSIS_ID$/Thermal

“@odata.type”: “FTSSchema.v1_0_0#Thermal.v1_2_2.Thermal"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSThermal.v1_0_0.FTSThermal"

no/yes Description Nullable, it

won’t be

supported

Temperatures::MinReadingRangeTemp Nullable, it

won’t be

supported

Temperatures::MaxReadingRangeTemp Nullable, it

won’t be

Page 25 of 45

supported

Temperatures::[email protected] Not

supported

Temperatures::[email protected] Not

supported

Temperatures::RelatedItem Not

supported

Fans ::MinReadingRange Nullable, it

won’t be

supported

Fans::[email protected] Not

supported


supported

Fans::RelatedItem Not

supported


supported

Fans::Redundancy @odata.nagivationLink Not

supported

Fans: Redundancy Not

supported


supported


supported

Redudancy Not

supported

/redfish/v1/JsonSchemas

“@odata.type”: “FTSSchema.v1_0_0#JsonSchemaFileCollection.JsonSchemaFileCollection"

no/no

Description

Nullable, it

won’t be

supported

Uri Not

supported

PublicationUri Not

supported

/redfish/v1/Managers

“@odata.type”: “FTSSchema.v1_0_0#ManagerCollection.ManagerCollection"

no/no Description

Read-only

limitation

/redfish/v1/Managers/iRMC

“@odata.type”: “FTSSchema.v1_0_0#Manager.v1_0_5.Manager"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSManager.v1_0_0.FTSManager"

no/yes Description

Read-only

limitation

Links::Oem Not

supported

DateTime Read-only

Page 26 of 45

limitation

Status::OEM Not

supported

DateTimeLocalOffset Read-only

limitation

NetworkProtocol:: @odata.id

Link exists,

but content

not

supported

VirtualMedia:: @odata.id

Link exists,

but content

not

supported


supported


supported

Redudancy Not

supported

/redfish/v1/Managers/iRMC/EthernetInterfaces

“@odata.type”: “FTSSchema.v1_0_0#EthernetInterfaceCollection.EthernetInterfaceCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/Managers/iRMC/EthernetInterfaces/$MGMT_LAN_ID$

“@odata.type”: “FTSSchema.v1_0_0#EthernetInterface.v1_0_4.EthernetInterface"

no Description

Read-only

limitation

UefiDevicePath

Nullable, it

won’t be

supported

InterfaceEnabled Read-only

limitation

PermanentMACAddress Read-only

limitation

MACAddress Read-only

limitation

SpeedMbps Read-only

limitation

AutoNeg

Nullable, it

won’t be

supported

FullDuplex

Nullable, it

won’t be

supported

MTUSize Nullable, it

Page 27 of 45

won’t be

supported

HostName Read-only

limitation

FQDN

Nullable, it

won’t be

supported

IPv6AddressPolicyTable Not

supported

IPv6AddressPolicyTable::Prefix Not

supported

IPv6AddressPolicyTable::Precedence Not

supported

IPv6AddressPolicyTable::Label Not

supported

IPv6StaticAddresses::Oem Not

supported

/redfish/v1/Managers/iRMC/EthernetInterfaces/$MGMT_LAN_ID$/VLANs

“@odata.type”: “FTSSchema.v1_0_0#VLanNetworkInterfaceCollection.VLanNetworkInterfaceCollection"

no Description

Read-only

limitation

Oem Not

supported

/redfish/v1/Managers/iRMC/EthernetInterfaces/$MGMT_LAN_ID$/VLANs/$VLAN_ID$

“@odata.type”: “FTSSchema.v1_0_0#VLanNetworkInterface.v1_0_3.VLanNetworkInterface"

no Description

Read-only

limitation

Oem Not

supported

/redfish/v1/Managers/iRMC/LogServices

“@odata.type”: “FTSSchema.v1_0_0#LogServiceCollection.LogServiceCollection"

no

Description

Nullable, it

won’t be

supported

Oem Not

supported

/redfish/v1/Managers/iRMC/LogServices/InternalEventLog

“@odata.type”: “FTSSchema.v1_0_0#LogService.v1_0_4.LogService"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSLogService.v1_1_0.FTSLogService"

no

Description

Nullable, it

won’t be

supported


limitation

DateTime Read-only

limitation


limitation

Status

Nullable, it

won’t be

supported

Page 28 of 45

Status::State

Nullable, it

won’t be

supported

Status::HealthRollup

Nullable, it

won’t be

supported

Status::Health

Nullable, it

won’t be

supported

Status::Oem

Nullable, it

won’t be

supported

/redfish/v1/Managers/iRMC/LogServices/InternalEventLog/Entries

“@odata.type”: “FTSSchema.v1_0_0#LogEntryCollection.LogEntryCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/Managers/iRMC/LogServices/InternalEventLog/Entries/$IEL_ID$

@odata.type": "#LogEntry.v1_0_4.LogEntry"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/F/STSSchema.v1_0_0#FTSiELEntry.v1_0_0.FTSiELEntry"

no/yes Description

Nullable, it

won’t be

supported

OemRecordFormat

SensorType

SensorNumber

Links::OriginOfCondition

/redfish/v1/Managers/iRMC/LogServices/SystemEventLog


OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSLogService.v1_1_0.FTSLogService"

no/yes

Description

Nullable, it

won’t be

supported


limitation

Actions::Oem Not

supported

DateTime Read-only

limitation


limitation

Status

Nullable, it

won’t be

supported

Status::State

Nullable, it

won’t be

supported


Nullable, it

won’t be

supported

Status::Health Nullable, it

won’t be

Page 29 of 45

supported

Status::Oem

Nullable, it

won’t be

supported

/redfish/v1/Managers/iRMC/LogServices/SystemEventLog/Entries

“@odata.type”: “FTSSchema.v1_0_0#LogEntryCollection.LogEntryCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/Managers/iRMC/LogServices/SystemEventLog/Entries/$SEL_ID$


OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSSELEntry.v1_0_0.FTSSELEntry "

no/yes

Description Nullable, it

won’t be

supported OemRecordFormat

Links::OriginOfCondition

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration

“@odata.type”: “FTSSchema.v1_0_0#FTSiRMCConfiguration.v2_0_0.FTSiRMCConfiguration"

no/OEM N/K


“@odata.type”: “FTSSchema.v1_0_0#FTSiRMCConfiguration.v1_0_0.FTSAISConnect"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/BiosConsole

“@odata.type”: “FTSSchema.v1_0_0#FTSiRMCConfiguration.v1_0_0.FTSBiosConsole"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Cas

“@odata.type”: “FTSSchema.v1_0_0#FTSiRMCConfiguration.v1_0_0.FTSCas"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Certificates

“@odata.type”: “FTSSchema.v1_0_0#FTSCertificates.v1_0_0.FTSCertificates"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Components

“@odata.type”: “FTSSchema.v1_0_0#FTSComponents.v1_0_0.FTSComponents"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Dns

“@odata.type”: “FTSSchema.v1_0_0#FTSDns.v1_0_0.FTSDns"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/DnsServers

“@odata.type”: “FTSSchema.v1_0_0#FTSDnsServerCollection.FTSDnsServerCollection"

no/OEM

Description

Nullable, it

won’t be

supported

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/DnsServers/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#FTSDnsServer.v1_0_0.FTSDnsServer"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/eLCM

“@odata.type”: “FTSSchema.v1_0_0#FTSeLCM.v1_1_0.FTSeLCM"

eLCM/OEM

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/eLCM/SDCustomImages

“@odata.type”: “FTSSchema.v1_0_0#FTSSDCustomImagesCollection.FTSSDCustomImagesCollection"

eLCM/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/eLCM/SDCustomImages/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#FTSSDCustomImage.v1_0_0.FTSSDCustomImage"

eLCM/OEM BootMode

Not

supported

Page 30 of 45

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Email

“@odata.type”: “FTSSchema.v1_0_0#FTSEmail.v1_0_0.FTSEmail"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/EventLog

“@odata.type”: “FTSSchema.v1_0_0#FTSEventLog.v1_0_0.FTSEventLog"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/FWUpdate

“@odata.type”: “FTSSchema.v1_0_0#FTSFWUpdate.v1_0_0.FTSFWUpdate"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/IpmiFencing

“@odata.type”: “FTSSchema.v1_0_0#FTSIpmiFencing.v1_0_0.FTSIpmiFencing"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Lan

“@odata.type”: “FTSSchema.v1_0_0#FTSLan.v1_0_0.FTSLan"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Ldap

“@odata.type”: “FTSSchema.v1_0_0#FTSLdap.v1_0_0.FTSLdap"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Ldap/LdapServers

“@odata.type”: “FTSSchema.v1_0_0#FTSLdapServerCollection. FTSLdapServerCollection "

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Ldap/LdapServers/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#FTSLdapServer.v1_0_0.FTSLdapServer"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Ldap/LdapUserGroups

“@odata.type”: “FTSSchema.v1_0_0#FTSLdapUserGroupCollection.FTSLdapUserGroupCollection"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Ldap/LdapUserGroups/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#FTSLdapUserGroup.v1_0_0.FTSLdapUserGroup"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Licenses

“@odata.type”: “FTSSchema.v1_0_0#FTSLicenses.v1_0_0.FTSLicenses"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Memory

“@odata.type”: “FTSSchema.v1_0_0#FTSMemory.v1_0_0.FTSMemory"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/NetworkServices

“@odata.type”: “FTSSchema.v1_0_0#FTSNetworkServices.v1_1_0.FTSNetworkServices"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/NetworkServices/TrapDestinations

“@odata.type”: “FTSSchema.v1_0_0#FTSTrapDestinationCollection.FTSTrapDestinationCollection"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/NetworkServices/TrapDestinations/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#FTSTrapDestination.v1_0_0.FTSTrapDestination"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/PowerSetting

“@odata.type”: “FTSSchema.v1_0_0#FTSPowerSetting.v1_0_0.FTSPowerSetting"

no/OEM N/K

/redfish/v1/$metadata#Managers/Members/iRMC/Oem/ts_fujitsu/iRMCConfiguration/PrimeCollect

"http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSPrimeCollect.v1_1_0.FTSPrimeCollect”

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Raid

“@odata.type”: “FTSSchema.v1_0_0#FTSRaid.v1_0_0.FTSRaid"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/RemoteManager

“@odata.type”: “FTSSchema.v1_0_0#FTSRemoteManager.v1_0_0.FTSRemoteManager"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/ServerManagement

“@odata.type”: “FTSSchema.v1_0_0FTSServerManagement.v1_0_0.FTSServerManagement"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Smtp

“@odata.type”: “FTSSchema.v1_0_0#FTSSmtpServerCollection.FTSSmtpServerCollection"

no/OEM N/K

Page 31 of 45

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Smtp/SmtpServers

“@odata.type”: “FTSSchema.v1_0_0#FTSSmtpServerCollection.FTSSmtpServerCollection"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Smtp/SmtpServers/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#FTSSmtpServer.v1_0_0.FTSSmtpServer"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Time

“@odata.type”: “FTSSchema.v1_0_0#FTSTime.v1_0_0.FTSTime"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Time/NtpServers

“@odata.type”: “FTSSchema.v1_0_0#FTSNtpServerCollection.FTSNtpServerCollection"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Time/NtpServers/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#FTSNtpServer.v1_0_0.FTSNtpServer"

no/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/VideoRedirection

“@odata.type”: “FTSSchema.v1_0_0#FTSVideoRedirection.v1_1_0.FTSVideoRedirection"

KVM/OEM N/K

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/WebUI

“@odata.type”: “FTSSchema.v1_0_0#FTSWebUI.v1_0_0.FTSWebUI"

no/OEM N/K

/redfish/v1/Managers/iRMC/SerialInterfaces

“@odata.type”: “FTSSchema.v1_0_0#SerialInterfaceCollection.SerialInterfaceCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/Managers/iRMC/VirtualMedia

“@odata.type”: “FTSSchema.v1_0_0#VirtualMediaCollection.VirtualMediaCollection"

MEDIA/no

Description

Nullable, it

won’t be

supported

/redfish/v1/Systems

“@odata.type”: “FTSSchema.v1_0_0#ComputerSystemCollection.ComputerSystemCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FirmwareInventory

"@odata.type": "FTSSchema.v1_0_0#FTSFirmwareInventory.v1_0_0.FTSFirmwareInventory"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FirmwareInventory/NIC

"@odata.type": "FTSSchema.v1_0_0#FTSFirmwareInventory.v1_1_0.FTSFirmwareInventoryNetworkElement"

no/OEM Ports::WWNN Not

supported Ports::WWPN

Ports::GUID

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FirmwareInventory/iSCSI


no/OEM Ports::WWNN

Not

supported

Ports::WWPN

Ports::GUID

Ports::PortStatus

Ports::AdapterName

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FirmwareInventory/RoCE


no/OEM Ports::WWNN

Not

supported

Ports::WWPN

Ports::GUID

Ports::PortStatus

Ports::AdapterName

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FirmwareInventory/FC


no/OEM Ports::GUID

Not

supported

Ports::MacAddress

Ports::PortStatus

Ports::AdapterName

Page 32 of 45

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FirmwareInventory/FCoE


no/OEM Ports::GUID Not

supported Ports::PortStatus

Ports::AdapterName

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FirmwareInventory/IB


no/OEM Ports::WWNN

Not

supported

Ports::WWPN

Ports::MacAddress

Ports::PortStatus

Ports::AdapterName

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FirmwareInventory/Storage

"@odata.type": "FTSSchema.v1_0_0#FTSFirmwareInventory.v1_1_0.FTSFirmwareInventoryStorageElement"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/BootConfig

“@odata.type”: “FTSSchema.v1_0_0#FTSBootConfig.v1_0_0.FTSBootConfig"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/VirtualMedia

“@odata.type”: “FTSSchema.v1_0_0#FTSVirtualMedia.v1_1_0.FTSVirtualMedia"

MEDIA/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/PowerOnOff

“@odata.type”: “FTSSchema.v1_0_0#FTSPowerOnOff.v1_0_0.FTSPowerOnOff"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/System

“@odata.type”: “FTSSchema.v1_0_0#FTSSystem.v1_0_0.FTSSystem"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FailureBehavior

“@odata.type”: “FTSSchema.v1_0_0#FTSFailureBehavior.v1_0_0.FTSFailureBehavior"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FailureBehavior/Fans

"@odata.type": "FTSSchema.v1_0_0#FTSFanConfigurationCollection.FTSFanConfigurationCollection"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FailureBehavior/Fans/$IDX$

"@odata.type": "FTSSchema.v1_0_0#FTSFanConfiguration.v1_0_0.FTSFanConfiguration"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FailureBehavior/Temperatures

"@odata.type": "FTSSchema.v1_0_0#FTSTemperatureConfigurationCollection.FTSTemperatureConfigurationCollection"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FailureBehavior/Temperatures/$IDX$

"@odata.type": "FTSSchema.v1_0_0#FTSTemperatureConfiguration.v1_0_0.FTSTemperatureConfiguration"

no/OEM N/K

/redfish/v1/Systems/$SYSTEM_ID$

“@odata.type”: “FTSSchema.v1_0_0#ComputerSystem.v1_3_2.ComputerSystem"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#

FTSComputerSystem.v1_3_0.FTSComputerSystem"

no/yes

SKU

Nullable, it

won’t be

supported

Boot::UefiTargetBootSourceOverride

Nullable, it

won’t be

supported

Description Read-only

limitation

HostName Read-only

limitation

BiosVersion Read-only

limitation

ProcessorSummary::Status::HealthRollUp Nullable, it

won’t be

Page 33 of 45

supported

MemorySummary::Status::HealthRollUp

Nullable, it

won’t be

supported

TrustedModules::FirmwareVersion Not

supported

TrustedModules::InterfaceType Not

supported

TrustedModules::Status::Health

Nullable, it

won’t be

supported

TrustedModules::Status::HealthRollup

Nullable, it

won’t be

supported

TrustedModules::FirmwareVersion2

Nullable, it

won’t be

supported

Links::Oem Not

supported

Links::[email protected] Not

supported

Links::[email protected] Not

supported

Links::Endpoints Not

supported


supported


supported

PCIeDevices Not

supported


supported


supported

PCIeFunctions Not

supported

MemoryDomains

Nullable, it

won’t be

supported

/redfish/v1/Systems/$SYSTEM_ID$/Bios

“@odata.type”: “FTSSchema.v1_0_0#Bios.v1_0_1.Bios"

no/no Description

Nullable,

only

Page 34 of 45

supported

on CX

Systems

AttributeRegistry

Nullable,

only

supported

on CX and

PQ Systems

Attributes

only

supported

on CX and

PQ Systems

/redfish/v1/Systems/$SYSTEM_ID$/Bios/Settings

“@odata.type”: “#Bios.v1_0_2.Bios“

no/no

only

supported

on CX and

PQ Systems

/redfish/v1/Systems/$SYSTEM_ID$/Bios/BiosParameterVersion

“@odata.type”: “#BiosParameterVersion.v1_0_0.BiosParameterVersion“

no/no

only

supported

on CX and

PQ Systems

/redfish/v1/Systems/$SYSTEM_ID$/EthernetInterfaces

“@odata.type”: “FTSSchema.v1_0_0#EthernetInterfaceCollection.EthernetInterfaceCollection"

no/no Description

Read-only

limitation

/redfish/v1/Systems/$SYSTEM_ID$/EthernetInterfaces/$ETHIF_IDX$

“@odata.type”: “FTSSchema.v1_0_0#EthernetInterface.v1_0_3.EthernetInterface"

no/no Description

Read-only

limitation

UefiDevicePath

Nullable, it

won’t be

supported

Status::HealthRollUp

Nullable, it

won’t be

supported

Status::Health

Nullable, it

won’t be

supported

InterfaceEnabled Read-only

limitation

SpeedMbps Read-only

limitation

AutoNeg

Nullable, it

won’t be

supported

FullDupley

Nullable, it

won’t be

supported

Page 35 of 45

MTUSize

Nullable, it

won’t be

supported

HostName Read-only

limitation

FQDN

Nullable, it

won’t be

supported

MaxStaticIPv6StaticIPAdresses

Nullable, it

won’t be

supported

VLAN

Nullable, it

won’t be

supported

IPv6AddressPolicyTable Not

supported

IPv6Addresses::PrefixLength

Nullable, it

won’t be

supported

IPv6Addresses::AddressOrigin

Nullable, it

won’t be

supported

IPv6Addresses::AddressState

Nullable, it

won’t be

supported

IPv6StaticAddresses Not

supported

NameServers Not

supported

/redfish/v1/Systems/$SYSTEM_ID$/EthernetInterfaces/$ETHIF_IDX$/VLANs

“@odata.type”: “FTSSchema.v1_0_0#VLanNetworkInterfaceCollection.VLanNetworkInterfaceCollection"

no/no

Members

Empty

collection is

always

returned

Description Read-only

limitation

Oem Not

supported

/redfish/v1/Systems/$SYSTEM_ID$/HostedServices/StorageServices

“@odata.type”: “FTSSchema.v1_0_0#HostedStorageServices.HostedStorageServices"

no/no Oem

Not

supported

Description

Nullable, it

won’t be

supported

Page 36 of 45

/redfish/v1/Systems/$SYSTEM_ID$/Memory

“@odata.type”: “FTSSchema.v1_0_0#MemoryCollection.MemoryCollection"

no/no

Description

Nullable, it

won’t be

supported

Oem Not

supported

/redfish/v1/Systems/$SYSTEM_ID$/Memory/$DIMM_ID$

“@odata.type”: “FTSSchema.v1_0_0#Memory.v1_3_0.Memory"

OEM: "@odata.type": "http://schemas.ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0# FTSMemory.v1_1_0.FTSMemory"

no/yes

Description

Nullable, it

won’t be

supported

AllowedSpeedsMHz Not

supported

FirmwareRevision

Nullable, it

won’t be

supported

FirmwareApiVersion

Nullable, it

won’t be

supported

FunctionClasses Not

supported

VendorID

Nullable, it

won’t be

supported

DeviceID

Nullable, it

won’t be

supported

SubsystemVendorID

Nullable, it

won’t be

supported

SubsystemDeviceID

Nullable, it

won’t be

supported

MaxTDPMilliWatts Not

supported

SecuryCapabilities::PassphraseCapable

Nullable, it

won’t be

supported

SecuryCapabilities::MaxPassphraseCount

Nullable, it

won’t be

supported

MemoryLocation Not

supported

MemoryLocation::Socket Nullable, it

won’t be

Page 37 of 45

supported

MemoryLocation::MemoryController

Nullable, it

won’t be

supported

MemoryLocation::Channel

Nullable, it

won’t be

supported

MemoryLocation::Slot

Nullable, it

won’t be

supported

VolatileRegionSizeLimitMiB

Nullable, it

won’t be

supported

PersistentRegionSizeLimitMiB

Nullable, it

won’t be

supported

Regions Not

supported

Regions::RegionId

Nullable, it

won’t be

supported

Regions::MemoryClassification

Nullable, it

won’t be

supported

Regions::OffsetMiB Nullable, it

won’t be

supported

Regions::SizeMiB Nullable, it

won’t be

supported

Regions::PassphraseState Nullable, it

won’t be

supported

PowerManagementPolicy Not

supported

PowerManagementPolicy::PolicyEnabled

Nullable, it

won’t be

supported

PowerManagementPolicy::MaxTDPMiliWatts

Nullable, it

won’t be

supported

PowerManagementPolicy::PeakPowerBudgetMiliWatts Nullable, it

Page 38 of 45

won’t be

supported

PowerManagementPolicy::AveragePowerBudgetMiliWatts

Nullable, it

won’t be

supported

IsRankSpareEnabled

Nullable, it

won’t be

supported

Status::Oem Not

supported

Actions::Oem Not

supported

Actions::#Memory.DisablePassphrase Not

supported

Actions::#Memory.SecureEraseUnit Not

supported

Actions::#Memory.SetPassphrase Not

supported

Actions::#Memory.UnlockUnit Not

supported

/redfish/v1/Systems/$SYSTEM_ID$/Memory/$DIMM_ID$/Metrics

“@odata.type”: “FTSSchema.v1_0_0#MemoryMetrics.v1_1_1.MemoryMetrics"

no/no

Resource

exists, but

there is no

functionality

behind

(not

supported)

/redfish/v1/Systems/$SYSTEM_ID$/NetworkInterfaces

“@odata.type”: “FTSSchema.v1_0_0#NetworkInterfaceCollection.NetworkInterfaceCollection"

no/no

Description

Nullable, it

won’t be

supported

Oem Not

supported

/redfish/v1/Systems/$SYSTEM_ID$/Processors

“@odata.type”: “FTSSchema.v1_0_0#ProcessorCollection.ProcessorCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/Systems/$SYSTEM_ID$/Processors/$CPU_ID$

“@odata.type”: “FTSSchema.v1_0_0#Processor.v1_0_4.Processor"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSCPU.v1_0_0.FTSCPU"

no/yes

Description

Nullable, it

won’t be

supported


Nullable, it

won’t be

supported

Status::Oem Not

Page 39 of 45

supported

/redfish/v1/Systems/$SYSTEM_ID$/SecureBoot

“@odata.type”: “FTSSchema.v1_0_0#SecureBoot.v1_0_1.SecureBoot"

no/no

Description

Nullable, it

won’t be

supported

Oem Not

supported

SecureBootEnable

Nullable, it

won’t be

supported

SecureBootCurrentBoot

Nullable, it

won’t be

supported

SecureBootMode

Nullable, it

won’t be

supported

Actions Not

supported

Actions::#SecureBoot.ResetKeys Action not

supported

Actions::Oem Not

supported

/redfish/v1/Systems/$SYSTEM_ID$/SimpleStorage

“@odata.type”: “FTSSchema.v1_0_0#SimpleStorageCollection.SimpleStorageCollection"

no/no

/redfish/v1/Systems/$SYSTEM_ID$/SimpleStorage/$SIMPLESTORAGE_ID$

“@odata.type”: “FTSSchema.v1_0_0#SimpleStorage.v1_1_2.SimpleStorage"

no/no

/redfish/v1/Systems/$SYSTEM_ID$/Storage

“@odata.type”: “FTSSchema.v1_0_0#StorageCollection.StorageCollection"

no/no

Description

Nullable, it

won’t be

supported

Oem Not

supported

/redfish/v1/Systems/$SYSTEM_ID$/Storage/$STORAGE_ID$/Volumes/$VOLUME_ID$ “@odata.type”: “#Volume.v1_0_3.Volume" OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSVolume.v1_0_0.FTSVolume"

Description

Nullable, it

won’t be

supported

Status::HealthRollUp

Nullable,

won’t be

supported

Identifiers Not

supported

Operations::AssociatedTasks Not

supported

Actions::Volume.Initialization Not

supported

Page 40 of 45

/redfish/v1/Systems/$SYSTEM_ID$/Storage/$STORAGE_ID$/Drives/$DRIVE_ID$

“@odata.type”: “#Drive.v1_1_2.Drive"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSDrive.v1_0_0.FTSDrive"

no/no Status::HealthRollUp

Nullable,

won’t be

supported

SKU Not

supported

PartNumber Not

supported

AssetTag Not

supported

Actions::Drive.SecureErase Not

supported

Operations::AssociatedTasks Not

supported

Links::Endpoints Not

supported

/redfish/v1/Systems/$SYSTEM_ID$/Storage/$STORAGE_ID$/Volumes “@odata.type”: “#VolumeCollection.VolumeCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/Systems/$SYSTEM_ID$/Storage/$STORAGE_ID$ “@odata.type”: “#Storage.v1_0_3.Storage"

OEM: "@odata.type":

"http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSStorageController.v1_0_0.FTSStorageController"

no/no

Description

Nullable, it

won’t be

supported

Actions::Storage.SetEncryptionKey Not

supported

StorageControllers::SKU Not

supported

StorageControllers::PartNumber Not

supported

StorageControllers::AssetTag Not

supported

Redundancy Not

supported

/redfish/v1/Systems/$SYSTEM_ID$/Storage/$STORAGE_ID$/Enclosures/$ENCLOSURE_ID$ “@odata.type”: “#Chassis.v1_0_5.Chassis"

OEM: "@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSEnclosure.v1_0_0.FTSEnclosure"

no/no

/redfish/v1/Systems/$SYSTEM_ID$/Storage/$STORAGE_ID$/Enclosures/$ENCLOSURE_ID$/Thermal “@odata.type”: “#Thermal.v1_2_2.Thermal"

no/no

/redfish/v1/Systems/$SYSTEM_ID$/Storage/$STORAGE_ID$/Enclosures/$ENCLOSURE_ID$/Power “@odata.type”: “#Power.v1_2_3.Power"

no/no

/redfish/v1/SessionService

“@odata.type”: “FTSSchema.v1_0_0#SessionService.v1_1_3.SessionService"

no/no

Description

Nullable, it

won’t be

supported

Status::HealthRollUp Nullable,

Page 41 of 45

won’t be

supported

Status::Oem Won’t be

supported


limitation

/redfish/v1/SessionService/Sessions

“@odata.type”: “FTSSchema.v1_0_0#SessionCollection.SessionCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/SessionService/Sessions/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#Session.v1_0_3.Session"

no/no

Description

Nullable, it

won’t be

supported

UserName

Read/write

instead of

read-only

/redfish/v1/TaskService

“@odata.type”: “FTSSchema.v1_0_0#TaskService.v1_1_0.TaskService"

no/no

Description

Nullable, it

won’t be

supported


limitation

/redfish/v1/TaskService/Tasks

“@odata.type”: “FTSSchema.v1_0_0#TaskCollection.TaskCollection"

no/no

Description

Nullable, it

won’t be

supported

/redfish/v1/TaskService/Tasks/$IDX$

“@odata.type”: “FTSSchema.v1_0_0#Task.v1_1_0.Task"

Oem "@odata.type":"http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSTask.v1_0_0.FTSTask"

no/yes

Description

Nullable, it

won’t be

supported

/redfish/v1/EventService

“@odata.type”: “FTSSchema.v1_0_0#EventService.v1_0_5.EventService"

no/no

Resource

exists, but

there is no

functionality

behind

(not

supported)

/redfish/v1/EventService/Subscriptions

“@odata.type”: “#EventDestinationCollection.EventDestinationCollection"

no/no

Resource

exists, but

there is no

functionality

behind

(not

supported)

/redfish/v1/Registries

“@odata.type”: “FTSSchema.v1_0_0#MessageRegistryFileCollection.MessageRegistryFileCollection"

no/no

Resource

exists, but

there is no

Page 42 of 45

functionality

behind

(not

supported)

/redfish/v1/Registries/BiosAttributeRegistryFJJ.v1_0_0

“@odata.type”: “AttributeRegistry.v1_0_1.AttributeRegistry"

no/no

only

supported

on CX

Systems

/redfish/v1/Oem/ts_fujitsu/FileDownload

"@odata.type": "http://ts.fujitsu.com/redfish-schemas/v1/FTSSchema.v1_0_0#FTSFileDownload.v1_0_0. FTSFileDownload"

no/no

/redfish/v1/odata no/no

/redfish/v1/Systems/$SYSTEM_ID$/ComputerSystemResetActionInfo

“@odata.type”: “ActionInfo.v1_0_2.ActionInfo"

no/no

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FTSComputerSystemResetActionInfo


no/no

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FTSComputerScreenshotActionInfo


no/no

/redfish/v1/Systems/$SYSTEM_ID$/Oem/ts_fujitsu/FTSComputerVirtualMediaActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/FTSManagerVirtualMediaServiceRestartActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/FTSManagerGetPowerHistoryActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/FTSManagerGetCpuHistoryActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/FTSManagerAddLicenseActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/FTSManagerSaveCustomConfigurationActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Dns/FTSDnsChangeDnsRecordActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/AISConnect/FTSAISConnetChangeAISStateActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/PrimeCollect/FTSPrimeCollectDownloadArchiveActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/PrimeCollect/FTSPrimeCollectSetArchiveAsReferencedActionInfo


no/no

/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/PrimeCollect/FTSPrimeCollectRemoveArchiveActionInfo


no/no

/redfish/v1/SessionService/Oem/ts_fujitsu/FTSSessionServiceDisconnectSessionActionInfo


no/no

/redfish/v1/Managers/iRMC/LogServices/InternalEventLog/Oem/ts_fujitsu/FTSLogServiceAddServiceNoteActionInfo no/no

Page 43 of 45


Page 44 of 45

3. Example Redfish requests

Table 11 Example Redfish requests

Request

type Description Request content

GET

Example GET on

authenticated resource

without ETag specified

curl -u admin:admin -k -H "Accept: application/json" -X GET -i "

“https://10.172.201.82/redfish/v1/AccountService"

GET

Example GET on

authenticated resource

with ETag specified

curl -u admin:admin -k -H "Accept: application/json" –H “If-None-Match: 1486035598” -X GET -i "

"https://10.172.201.82/redfish/v1/AccountService"

GET

An example GET request

authenticated with

session token

curl –k –X DELETE –H „X-Auth-Token: a1231adasd” –i ttps://10.172.201.82/redfish/v1/SessionService

GET Schema download curl –u admin:admin –k –H “Accept: application/octet-stream” –X GET –i

“https://10.172.201.82/redfish/schemas/FTSRedfishSchema.zip” > b.zip

GET Simple file download

1) Check supported files for download:

curl –u admin:admin –k –H “Accept: application/json” –X GET –i

“https://10.172.201.82/redfish/v1/Oem/ts_fujitsu/FileDownload”

2) Try to download file

curl –u admin:admin –k –H “Accept: text/plain” –X GET –

i ”https://10.172.201.82/redfish/v1/Oem/ts_fujitsu/FileDownload/RedfishSrvLog”

PATCH

An example PATCH

request with known ETag

value

curl –u admin:admin –H “Content-type: application/json“ –H “If-Match: 1486644448” –k –d

‘{“AlertChassisEvents”:false}’ –X PATCH –I

“https://10.172.201.82/redfish/v1/Managers/iRMC/Oem/ts_fujitsu/iRMCConfiguration/Email”

POST

POST action request to

upload FW (example of

data transfer)

curl -u admin:admin -k -H "Content-type: multipart/form-data” –H “Accept: application/json" -X POST

-i -F "data=@D3289-B1_98.80a_sdr03.13.bin"

"https://10.172.201.82/redfish/v1/Managers/iRMC/Actions/Oem/FTSManager.FWUpdate"

POST POST request to create a

new session

curl –H “Content-type: application/json” –k –d ‘{“UserName”:”admin”, “Password”:”admin”}’ –X POST –I

“https://10.172.201.82/redfish/v1/SessionService/Sessions”

DELETE DELETE request to remove

a session

curl –k –X DELETE –H „X-Auth-Token: a1231adasd” –i

https://10.172.201.82/redfish/v1/SessionService/Sessions/0

Page 45 of 45

4. Contents

Snippet 1 Example WebServer to Redfish Service message data bytes structure .................................................................................................... 4 Snippet 2 Example Redfish to WebServer message data bytes structure ................................................................................................................ 4 Snippet 3 An example GenericMap file replacement pattern definition ................................................................................................................. 7 Snippet 4 Standard resource example ................................................................................................................................................................... 8 Snippet 5 Standard resource without replacement patterns .................................................................................................................................. 9 Snippet 6 Resource collection with single MRI definition ....................................................................................................................................... 9 Snippet 7 Resource collection with multiple MRI definitions .................................................................................................................................. 9 Snippet 8 ResourceTree example structure .......................................................................................................................................................... 11

Figure 1 Architecture overview .............................................................................................................................................................................. 3 Figure 2 An example TRIE node handling for an example replacement pattern ..................................................................................................... 7 Figure 3 MRI structures for an example user account setup ................................................................................................................................. 12 Figure 4 MRI structures for an example VLAN configuration ................................................................................................................................ 13

Table 1 Redfish-WebServer interprocess socket-based protocol description ............................................................................................................ 4 Table 2 Supported HTTP headers ........................................................................................................................................................................... 5 Table 3 GenericMap - replacement pattern properties description ......................................................................................................................... 5 Table 4 GenericMap - accepted conversion definitions ........................................................................................................................................... 6 Table 5 Resource properties appended by framework .......................................................................................................................................... 10 Table 6 Resource Tree entry properties description .............................................................................................................................................. 10 Table 7 List of supported internal events ............................................................................................................................................................. 14 Table 8 Fujitsu OEM extended messages ............................................................................................................................................................ 14 Table 9 Actions specification ............................................................................................................................................................................... 16 Table 10 Complete supported Resource Tree with the description of limitations ................................................................................................... 20 Table 11 Example Redfish requests ..................................................................................................................................................................... 44

Documents

Redfish iRMC S5 - Fujitsumanuals.ts.fujitsu.com/file/13377/irmc-redfish-spec-en.pdf · The API document applies for iRMC S5 systems ... Snippet 1 Example WebServer to Redfish Service