Proposed OCP Redfish Profile

This draft example, for ongoing development, represents a proposed minimal Redfish data model "profile" that meets the needs of the Open Compute Project’s Hardware Management requirements. This draft profile is intended to help define a list of required properties so that essential management-related tasks, as defined by OCP, can be performed on any Redfish implementation.

Navigate through the data model using the blue links shown in the JSON payloads, or use the shortcuts on the left side to quickly jump to specific points of interest in the model. Clicking on an info icon in the JSON payload will reveal the definition and other information about that property.

Explore the Resources

Normative requirements
Theme
"@odata.type":view details "#ManagerAccountCollection.ManagerAccountCollection",

(loading ...)

"Name":view details "Accounts Collection",

(loading ...)

"@odata.id":view details "/redfish/v1/AccountService/Accounts"

(loading ...)

"@odata.type":view details "#ManagerAccount.v1_12_0.ManagerAccount",

(loading ...)

"Id":view details "jane",

(loading ...)

"Name":view details "UserAccount",

(loading ...)

"Description":view details "User Account",

(loading ...)

"Enabled":view details true,

(loading ...)

"Password":view details null,

(loading ...)

expandcollapse"AccountTypes":view details [

(loading ...)

"Redfish"
]
,
"UserName":view details "jane",

(loading ...)

"RoleId":view details "Operator",

(loading ...)

"Locked":view details false,

(loading ...)

"@odata.id":view details "/redfish/v1/AccountService/Accounts/jane"

(loading ...)

"@odata.type":view details "#ManagerAccount.v1_12_0.ManagerAccount",

(loading ...)

"Id":view details "john",

(loading ...)

"Name":view details "UserAccount",

(loading ...)

"Description":view details "User Account",

(loading ...)

"Enabled":view details true,

(loading ...)

"Password":view details null,

(loading ...)

expandcollapse"AccountTypes":view details [

(loading ...)

"Redfish"
]
,
"UserName":view details "john",

(loading ...)

"RoleId":view details "ReadOnly",

(loading ...)

"Locked":view details false,

(loading ...)

"@odata.id":view details "/redfish/v1/AccountService/Accounts/john"

(loading ...)

"@odata.type":view details "#ManagerAccount.v1_12_0.ManagerAccount",

(loading ...)

"Id":view details "root",

(loading ...)

"Name":view details "UserAccount",

(loading ...)

"Description":view details "User Account",

(loading ...)

"Enabled":view details true,

(loading ...)

"Password":view details null,

(loading ...)

expandcollapse"AccountTypes":view details [

(loading ...)

"Redfish"
]
,
"UserName":view details "root",

(loading ...)

"RoleId":view details "Administrator",

(loading ...)

"Locked":view details false,

(loading ...)

"@odata.id":view details "/redfish/v1/AccountService/Accounts/root"

(loading ...)

"@odata.type":view details "#Role.v1_3_1.Role",

(loading ...)

"Id":view details "Administrator",

(loading ...)

"Name":view details "User Role",

(loading ...)

"Description":view details "Admin User Role",

(loading ...)

"IsPredefined":view details true,

(loading ...)

expandcollapse"AssignedPrivileges":view details [

(loading ...)

"Login",
"ConfigureManager",
"ConfigureUsers",
"ConfigureSelf",
"ConfigureComponents"
]
,
"@odata.id":view details "/redfish/v1/AccountService/Roles/Administrator"

(loading ...)

"@odata.type":view details "#Role.v1_3_1.Role",

(loading ...)

"Id":view details "Operator",

(loading ...)

"Name":view details "User Role",

(loading ...)

"Description":view details "Operator User Role",

(loading ...)

"IsPredefined":view details true,

(loading ...)

expandcollapse"AssignedPrivileges":view details [

(loading ...)

"Login",
"ConfigureSelf",
"ConfigureComponents"
]
,
"@odata.id":view details "/redfish/v1/AccountService/Roles/Operator"

(loading ...)

"@odata.type":view details "#Role.v1_3_1.Role",

(loading ...)

"Id":view details "ReadOnly",

(loading ...)

"Name":view details "User Role",

(loading ...)

"Description":view details "ReadOnly User Role",

(loading ...)

"IsPredefined":view details true,

(loading ...)

expandcollapse"AssignedPrivileges":view details [

(loading ...)

"Login",
"ConfigureSelf"
]
,
"@odata.id":view details "/redfish/v1/AccountService/Roles/ReadOnly"

(loading ...)

"@odata.type":view details "#AccountService.v1_15_0.AccountService",

(loading ...)

"Id":view details "AccountService",

(loading ...)

"Name":view details "Account Service",

(loading ...)

"Description":view details "Account Service",

(loading ...)

"Status":view details {

(loading ...)

"State":view details "Enabled",

(loading ...)

"Health":view details "OK"

(loading ...)

} ,
"ServiceEnabled":view details true,

(loading ...)

"@odata.id":view details "/redfish/v1/AccountService"

(loading ...)

"@odata.type":view details "#Power.v1_7_2.Power",

(loading ...)

"Id":view details "Power",

(loading ...)

"Name":view details "Power",

(loading ...)

expandcollapse"PowerControl":view details [

(loading ...)

{
"MemberId":view details "0",

(loading ...)

"Name":view details "System Power Control",

(loading ...)

"PowerLimit":view details {

(loading ...)

"LimitInWatts":view details 450,

(loading ...)

"LimitException":view details "LogEventOnly",

(loading ...)

"CorrectionInMs":view details 1000

(loading ...)

} ,
"Status":view details {

(loading ...)

"State":view details "Enabled",

(loading ...)

"Health":view details "OK"

(loading ...)

}
}
]
,
"@odata.id":view details "/redfish/v1/Chassis/1/Power"

(loading ...)

"@odata.type":view details "#Thermal.v1_7_2.Thermal",

(loading ...)

"Id":view details "Thermal",

(loading ...)

"Name":view details "Thermal",

(loading ...)

expandcollapse"Temperatures":view details [

(loading ...)

]
,
expandcollapse"Fans":view details [

(loading ...)

]
,
"@odata.id":view details "/redfish/v1/Chassis/1/Thermal"

(loading ...)

"@odata.type":view details "#Chassis.v1_25_0.Chassis",

(loading ...)

"Id":view details "1",

(loading ...)

"Name":view details "Catfish System Chassis",

(loading ...)

"ChassisType":view details "RackMount",

(loading ...)

"Manufacturer":view details "CatfishManufacturer",

(loading ...)

"Model":view details "YellowCat1000",

(loading ...)

"SerialNumber":view details "2M220100SL",

(loading ...)

"SKU":view details "",

(loading ...)

"PartNumber":view details "",

(loading ...)

"AssetTag":view details "CATFISHASSETTAG",

(loading ...)

"IndicatorLED":view details "Lit",

(loading ...)

"PowerState":view details "On",

(loading ...)

"Status":view details {

(loading ...)

"State":view details "Enabled",

(loading ...)

"Health":view details "OK"

(loading ...)

} ,
"@odata.id":view details "/redfish/v1/Chassis/1"

(loading ...)

"@odata.type":view details "#ChassisCollection.ChassisCollection",

(loading ...)

"Name":view details "Chassis Collection",

(loading ...)

"@odata.id":view details "/redfish/v1/Chassis"

(loading ...)

"@odata.type":view details "#EthernetInterface.v1_12_0.EthernetInterface",

(loading ...)

"Id":view details "eth0",

(loading ...)

"Name":view details "Manager Ethernet Interface",

(loading ...)

"Description":view details "Management Network Interface",

(loading ...)

"Status":view details {

(loading ...)

"State":view details "Enabled",

(loading ...)

"Health":view details "OK"

(loading ...)

} ,
"InterfaceEnabled":view details true,

(loading ...)

"PermanentMACAddress":view details "AA:BB:CC:DD:EE:FF",

(loading ...)

"MACAddress":view details "AA:BB:CC:DD:EE:FF",

(loading ...)

"SpeedMbps":view details 100,

(loading ...)

"AutoNeg":view details true,

(loading ...)

"FullDuplex":view details true,

(loading ...)

"MTUSize":view details 1500,

(loading ...)

"HostName":view details "MyHostName",

(loading ...)

"FQDN":view details "MyHostName.MyDomainName.com",

(loading ...)

"VLAN":view details {

(loading ...)

"VLANEnable":view details true,

(loading ...)

"VLANId":view details 101

(loading ...)

} ,
expandcollapse"IPv4Addresses":view details [

(loading ...)

{
"Address":view details "192.168.0.10",

(loading ...)

"SubnetMask":view details "255.255.252.0",

(loading ...)

"AddressOrigin":view details "DHCP",

(loading ...)

"Gateway":view details "192.168.0.1"

(loading ...)

}
]
,
expandcollapse"IPv6AddressPolicyTable":view details [

(loading ...)

{
"Prefix":view details "::1/128",

(loading ...)

"Precedence":view details 50,

(loading ...)

"Label":view details 0

(loading ...)

}
]
,
expandcollapse"IPv6StaticAddresses":view details [

(loading ...)

{
"Address":view details "fe80::1ec1:deff:fe6f:1e24",

(loading ...)

"PrefixLength":view details 16

(loading ...)

}
]
,
"IPv6DefaultGateway":view details "fe80::1ec1:deff:fe6f:1e24",

(loading ...)

expandcollapse"IPv6Addresses":view details [

(loading ...)

{
"Address":view details "fe80::1ec1:deff:fe6f:1e24",

(loading ...)

"PrefixLength":view details 64,

(loading ...)

"AddressOrigin":view details "SLAAC",

(loading ...)

"AddressState":view details "Preferred"

(loading ...)

}
]
,
"@odata.id":view details "/redfish/v1/Managers/bmc/EthernetInterfaces/eth0"

(loading ...)

"@odata.type":view details "#EthernetInterfaceCollection.EthernetInterfaceCollection",

(loading ...)

"Name":view details "Ethernet Network Interface Collection",

(loading ...)

"Description":view details "Collection of EthernetInterfaces for this Manager",

(loading ...)

"@odata.id":view details "/redfish/v1/Managers/bmc/EthernetInterfaces"

(loading ...)

"@odata.type":view details "#ManagerNetworkProtocol.v1_10_0.ManagerNetworkProtocol",

(loading ...)

"Id":view details "NetworkProtocol",

(loading ...)

"Name":view details "Manager Network Protocol",

(loading ...)

"Description":view details "Manager Network Service Status",

(loading ...)

"Status":view details {

(loading ...)

"State":view details "Enabled",

(loading ...)

"Health":view details "OK"

(loading ...)

} ,
"HostName":view details "myBmcHostname",

(loading ...)

"FQDN":view details "mymanager.mydomain.com",

(loading ...)

"HTTP":view details {

(loading ...)

"ProtocolEnabled":view details true,

(loading ...)

"Port":view details 80

(loading ...)

} ,
"HTTPS":view details {

(loading ...)

"ProtocolEnabled":view details true,

(loading ...)

"Port":view details 443

(loading ...)

} ,
"IPMI":view details {

(loading ...)

"ProtocolEnabled":view details true,

(loading ...)

"Port":view details 623

(loading ...)

} ,
"SSH":view details {

(loading ...)

"ProtocolEnabled":view details true,

(loading ...)

"Port":view details 22

(loading ...)

} ,
"SNMP":view details {

(loading ...)

"ProtocolEnabled":view details true,

(loading ...)

"Port":view details 161

(loading ...)

} ,
"SSDP":view details {

(loading ...)

"ProtocolEnabled":view details true,

(loading ...)

"Port":view details 1900,

(loading ...)

"NotifyTTL":view details 5,

(loading ...)

"NotifyIPv6Scope":view details "Site"

(loading ...)

} ,
"Telnet":view details {

(loading ...)

"ProtocolEnabled":view details true,

(loading ...)

"Port":view details 23

(loading ...)

} ,
"@odata.id":view details "/redfish/v1/Managers/bmc/NetworkProtocol"

(loading ...)

"@odata.type":view details "#Manager.v1_19_0.Manager",

(loading ...)

"Id":view details "bmc",

(loading ...)

"Name":view details "Manager",

(loading ...)

"ManagerType":view details "BMC",

(loading ...)

"Description":view details "BMC",

(loading ...)

"ServiceEntryPointUUID":view details "92384634-2938-2342-8820-489239905423",

(loading ...)

"UUID":view details "00000000-0000-0000-0000-000000000000",

(loading ...)

"Model":view details "CatfishBMC",

(loading ...)

"DateTime":view details "2015-03-13T04:14:33+06:00",

(loading ...)

"DateTimeLocalOffset":view details "+06:00",

(loading ...)

"Status":view details {

(loading ...)

"State":view details "Enabled",

(loading ...)

"Health":view details "OK"

(loading ...)

} ,
"FirmwareVersion":view details "1.00",

(loading ...)

"Actions":view details {

(loading ...)

"#Manager.Reset":view details {

(loading ...)

"target":view details "/redfish/v1/Managers/bmc/Actions/Manager.Reset",

(loading ...)

expandcollapse"ResetType@Redfish.AllowableValues":view details [

(loading ...)

"ForceRestart",
"GracefulRestart"
]
}
} ,
"@odata.id":view details "/redfish/v1/Managers/bmc"

(loading ...)

"@odata.type":view details "#ManagerCollection.ManagerCollection",

(loading ...)

"Name":view details "Manager Collection",

(loading ...)

"@odata.id":view details "/redfish/v1/Managers"

(loading ...)

"@odata.type":view details "#Session.v1_7_1.Session",

(loading ...)

"Id":view details "1234567890ABCDEF",

(loading ...)

"Name":view details "User Session",

(loading ...)

"Description":view details "Manager User Session",

(loading ...)

"UserName":view details "root",

(loading ...)

"@odata.id":view details "/redfish/v1/SessionService/Sessions/1234567890ABCDEF"

(loading ...)

"@odata.type":view details "#SessionCollection.SessionCollection",

(loading ...)

"Name":view details "Session Collection",

(loading ...)

"@odata.id":view details "/redfish/v1/SessionService/Sessions"

(loading ...)

"@odata.type":view details "#SessionService.v1_1_8.SessionService",

(loading ...)

"Id":view details "SessionService",

(loading ...)

"Name":view details "Session Service",

(loading ...)

"Description":view details "Session Service",

(loading ...)

"Status":view details {

(loading ...)

"State":view details "Enabled",

(loading ...)

"Health":view details "OK"

(loading ...)

} ,
"ServiceEnabled":view details true,

(loading ...)

"@odata.id":view details "/redfish/v1/SessionService"

(loading ...)

"@odata.type":view details "#LogEntry.v1_16_0.LogEntry",

(loading ...)

"Id":view details "1",

(loading ...)

"Name":view details "Log Entry 1",

(loading ...)

"EntryType":view details "SEL",

(loading ...)

"Severity":view details "Critical",

(loading ...)

"Created":view details "2012-03-07T14:44:00Z",

(loading ...)

"EntryCode":view details "Upper Critical - going high",

(loading ...)

"SensorType":view details "Temperature",

(loading ...)

"SensorNumber":view details 1,

(loading ...)

"Message":view details "Temperature threshold exceeded",

(loading ...)

"MessageId":view details "0x592A28",

(loading ...)

"@odata.id":view details "/redfish/v1/Systems/1/LogServices/SEL/Entries/1"

(loading ...)

"@odata.type":view details "#LogEntry.v1_16_0.LogEntry",

(loading ...)

"Id":view details "2",

(loading ...)

"Name":view details "Log Entry 2",

(loading ...)

"EntryType":view details "SEL",

(loading ...)

"Severity":view details "Critical",

(loading ...)

"Created":view details "2012-03-07T14:45:00Z",

(loading ...)

"EntryCode":view details "Upper Critical - going high",

(loading ...)

"SensorType":view details "Temperature",

(loading ...)

"SensorNumber":view details 2,

(loading ...)

"Message":view details "Temperature threshold exceeded",

(loading ...)

"MessageId":view details "0x592E28",

(loading ...)

"@odata.id":view details "/redfish/v1/Systems/1/LogServices/SEL/Entries/2"

(loading ...)

"@odata.type":view details "#LogEntryCollection.LogEntryCollection",

(loading ...)

"Name":view details "Log Service Collection",

(loading ...)

"Description":view details "Collection of Logs for this System",

(loading ...)

expandcollapse"Members":view details [

(loading ...)

{
"@odata.type":view details "#LogEntry.v1_16_0.LogEntry",

(loading ...)

"Id":view details "1",

(loading ...)

"Name":view details "Log Entry 1",

(loading ...)

"EntryType":view details "SEL",

(loading ...)

"Severity":view details "Critical",

(loading ...)

"Created":view details "2012-03-07T14:44:00Z",

(loading ...)

"EntryCode":view details "Upper Critical - going high",

(loading ...)

"SensorType":view details "Temperature",

(loading ...)

"SensorNumber":view details 1,

(loading ...)

"Message":view details "Temperature threshold exceeded",

(loading ...)

"MessageId":view details "0x592A28",

(loading ...)

} ,
{
"@odata.type":view details "#LogEntry.v1_16_0.LogEntry",

(loading ...)

"Id":view details "2",

(loading ...)

"Name":view details "Log Entry 2",

(loading ...)

"EntryType":view details "SEL",

(loading ...)

"Severity":view details "Critical",

(loading ...)

"Created":view details "2012-03-07T14:45:00Z",

(loading ...)

"EntryCode":view details "Upper Critical - going high",

(loading ...)

"SensorType":view details "Temperature",

(loading ...)

"SensorNumber":view details 2,

(loading ...)

"Message":view details "Temperature threshold exceeded",

(loading ...)

"MessageId":view details "0x592E28",

(loading ...)

}
]
,
"@odata.id":view details "/redfish/v1/Systems/1/LogServices/SEL/Entries"

(loading ...)

"@odata.type":view details "#LogService.v1_6_0.LogService",

(loading ...)

"Id":view details "SEL",

(loading ...)

"Name":view details "System Log Service",

(loading ...)

"OverWritePolicy":view details "WrapsWhenFull",

(loading ...)

"DateTime":view details "2015-03-13T04:14:33+06:00",

(loading ...)

"DateTimeLocalOffset":view details "+06:00",

(loading ...)

"ServiceEnabled":view details true,

(loading ...)

"Status":view details {

(loading ...)

"State":view details "Enabled",

(loading ...)

"Health":view details "OK"

(loading ...)

} ,
"Actions":view details {

(loading ...)

"#LogService.ClearLog":view details {

(loading ...)

"target":view details "/redfish/v1/Systems/1/LogServices/SEL/Actions/LogService.ClearLog"

(loading ...)

}
} ,
"@odata.id":view details "/redfish/v1/Systems/1/LogServices/SEL"

(loading ...)

"@odata.type":view details "#LogServiceCollection.LogServiceCollection",

(loading ...)

"Name":view details "Log Service Collection",

(loading ...)

"Description":view details "Collection of Logs for this System",

(loading ...)

"@odata.id":view details "/redfish/v1/Systems/1/LogServices"

(loading ...)

"@odata.type":view details "#ComputerSystem.v1_22_0.ComputerSystem",

(loading ...)

"Id":view details "1",

(loading ...)

"Name":view details "Catfish System",

(loading ...)

"SystemType":view details "Physical",

(loading ...)

"AssetTag":view details "CATFISHASSETTAG",

(loading ...)

"Manufacturer":view details "CatfishManufacturer",

(loading ...)

"Model":view details "YellowCat1000",

(loading ...)

"SerialNumber":view details "2M220100SL",

(loading ...)

"SKU":view details "",

(loading ...)

"PartNumber":view details "",

(loading ...)

"Description":view details "Catfish Implementation Recipe of simple scale-out monolithic server",

(loading ...)

"UUID":view details "00000000-0000-0000-0000-000000000000",

(loading ...)

"HostName":view details "catfishHostname",

(loading ...)

"PowerState":view details "On",

(loading ...)

"BiosVersion":view details "X00.1.2.3.4(build-23)",

(loading ...)

"Status":view details {

(loading ...)

"State":view details "Enabled",

(loading ...)

"Health":view details "OK"

(loading ...)

} ,
"IndicatorLED":view details "Off",

(loading ...)

"Boot":view details {

(loading ...)

"UefiTargetBootSourceOverride":view details "uefiDevicePath",

(loading ...)

expandcollapse"BootSourceOverrideTarget@Redfish.AllowableValues":view details [

(loading ...)

"None",
"Pxe",
"Usb",
"Hdd",
"BiosSetup",
"UefiTarget",
"UefiHttp"
]
} ,
"Actions":view details {

(loading ...)

"#ComputerSystem.Reset":view details {

(loading ...)

"target":view details "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",

(loading ...)

expandcollapse"ResetType@Redfish.AllowableValues":view details [

(loading ...)

"On",
"ForceOff",
"GracefulShutdown",
"ForceRestart",
"Nmi",
"GracefulRestart",
"ForceOn"
]
}
} ,
"@odata.id":view details "/redfish/v1/Systems/1"

(loading ...)

"@odata.type":view details "#ComputerSystemCollection.ComputerSystemCollection",

(loading ...)

"Name":view details "Computer System Collection",

(loading ...)

"@odata.id":view details "/redfish/v1/Systems"

(loading ...)

"@odata.type":view details "#ServiceRoot.v1_16_1.ServiceRoot",

(loading ...)

"Id":view details "RootService",

(loading ...)

"Name":view details "Root Service",

(loading ...)

"RedfishVersion":view details "1.15.0",

(loading ...)

"UUID":view details "92384634-2938-2342-8820-489239905423",

(loading ...)

"ProtocolFeaturesSupported":view details {

(loading ...)

"ExpandQuery":view details {

(loading ...)

"ExpandAll":view details true,

(loading ...)

"Levels":view details true,

(loading ...)

"MaxLevels":view details 6,

(loading ...)

} ,
"SelectQuery":view details false,

(loading ...)

"FilterQuery":view details false,

(loading ...)

"OnlyMemberQuery":view details true,

(loading ...)

"ExcerptQuery":view details true

(loading ...)

} ,
"@odata.id":view details "/redfish/v1/"

(loading ...)