redfish: Add OEM BMC Pairing schema for IBM #1437
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0"> | ||
| <edmx:Reference | ||
| Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml"> | ||
| <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData" /> | ||
| </edmx:Reference> | ||
| <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Manager_v1.xml"> | ||
| <edmx:Include Namespace="Manager" /> | ||
| <edmx:Include Namespace="Manager.v1_15_0.Manager" /> | ||
| </edmx:Reference> | ||
| <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml"> | ||
| <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish" /> | ||
| </edmx:Reference> | ||
| <edmx:DataServices> | ||
| <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OemBmcPairing"> | ||
| <Annotation Term="Redfish.OwningEntity" String="IBM" /> | ||
| </Schema> | ||
| <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OemBmcPairing.v1_0_0"> | ||
| <ComplexType Name="BmcPairing"> | ||
| <Annotation Term="OData.AdditionalProperties" Bool="false" /> | ||
| <Annotation Term="OData.Description" String="BMC Pairing information." /> | ||
| <Annotation Term="OData.LongDescription" | ||
| String="This type shall contain information about the BMC pairing status." /> | ||
| <Property Name="Paired" Type="Edm.Boolean"> | ||
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read" /> | ||
| <Annotation Term="OData.Description" | ||
| String="Indicates whether this BMC is paired with another BMC." /> | ||
| <Annotation Term="OData.LongDescription" | ||
| String="This property shall indicate whether this BMC is currently paired with another BMC. A value of true indicates the BMC is paired, false indicates it is not paired." /> | ||
| </Property> | ||
| <Property Name="AvailableBmcs" Type="Collection(Edm.String)"> | ||
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read" /> | ||
| <Annotation Term="OData.Description" | ||
| String="The names of BMCs that are available for pairing." /> | ||
| <Annotation Term="OData.LongDescription" | ||
| String="This property shall contain an array of names of BMCs that are discovered and available for pairing with this BMC. This array may be empty if no BMCs are currently available for pairing." /> | ||
| </Property> | ||
| </ComplexType> | ||
| <Action Name="Pair" IsBound="true"> | ||
| <Annotation Term="OData.Description" | ||
| String="This action pairs this BMC with another BMC." /> | ||
| <Annotation Term="OData.LongDescription" | ||
| String="This action shall establish a pairing relationship between this BMC and the specified target BMC." /> | ||
| <Parameter Name="Manager" Type="Manager.v1_0_0.OemActions" /> | ||
| <Parameter Name="BmcName" Type="Edm.String" Nullable="false"> | ||
| <Annotation Term="OData.Description" String="The name of the BMC to pair with." /> | ||
| <Annotation Term="OData.LongDescription" | ||
| String="This parameter shall contain the name or identifier of the BMC to establish pairing with." /> | ||
|
Contributor
There was a problem hiding this comment. What is meant here by name or identifier? Is this a Redfish link, DBus object path?
Contributor
Author
There was a problem hiding this comment. Its not redfish link. It is a string name (peer or self) |
||
| </Parameter> | ||
| </Action> | ||
| </Schema> | ||
| </edmx:DataServices> | ||
| </edmx:Edmx> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "$id": "https://github.com/ibm-openbmc/bmcweb/tree/HEAD/redfish-core/schema/oem/ibm/json-schema/OemBmcPairing.json", | ||
| "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", | ||
| "copyright": "Copyright 2026 OpenBMC.", | ||
| "definitions": {}, | ||
| "owningEntity": "IBM", | ||
| "title": "#OemBmcPairing" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| { | ||
| "$id": "https://github.com/ibm-openbmc/bmcweb/tree/HEAD/redfish-core/schema/oem/ibm/json-schema/OemBmcPairing.v1_0_0.json", | ||
| "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", | ||
| "Copyright": "Copyright 2026 OpenBMC.", | ||
| "definitions": { | ||
| "BmcPairing": { | ||
| "additionalProperties": false, | ||
| "description": "BMC Pairing information", | ||
| "patternProperties": { | ||
| "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { | ||
| "description": "This property shall specify a valid odata or Redfish property.", | ||
| "type": [ | ||
| "array", | ||
| "boolean", | ||
| "integer", | ||
| "number", | ||
| "null", | ||
| "object", | ||
| "string" | ||
| ] | ||
| } | ||
| }, | ||
| "properties": { | ||
| "Paired": { | ||
| "description": "Indicates whether this BMC is paired with another BMC", | ||
| "longDescription": "This property shall indicate whether this BMC is currently paired with another BMC. A value of true indicates the BMC is paired, false indicates it is not paired.", | ||
| "type": "boolean", | ||
| "readonly": true | ||
| }, | ||
| "AvailableBmcs": { | ||
| "description": "The names of BMCs that are available for pairing", | ||
| "longDescription": "This property shall contain an array of names of BMCs that are discovered and available for pairing with this BMC. This array may be empty if no BMCs are currently available for pairing.", | ||
|
Contributor
There was a problem hiding this comment. Same question here on meaning of names
Contributor
Author
There was a problem hiding this comment. It is answered above |
||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "readonly": true | ||
| } | ||
| }, | ||
| "type": "object" | ||
| }, | ||
| "Pair": { | ||
|
Contributor
There was a problem hiding this comment. The DMTF schemas define the Actions separately under "Actions". I'm wondering if this should be done similarly?
Contributor
Author
There was a problem hiding this comment. You have any example for it?
Contributor
There was a problem hiding this comment. Here is one of them, I'm seeing it in many of them: |
||
| "additionalProperties": false, | ||
| "description": "This action pairs this BMC with another BMC", | ||
| "parameters": { | ||
| "BmcName": { | ||
| "description": "The name of the BMC to pair with", | ||
| "longDescription": "This parameter shall contain the name or identifier of the BMC to establish pairing with.", | ||
|
Contributor
There was a problem hiding this comment. Same question here on meaning of name
Contributor
Author
There was a problem hiding this comment. Answered above |
||
| "requiredParameter": true, | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "patternProperties": { | ||
| "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { | ||
| "description": "This property shall specify a valid odata or Redfish property.", | ||
| "type": [ | ||
| "array", | ||
| "boolean", | ||
| "integer", | ||
| "number", | ||
| "null", | ||
| "object", | ||
| "string" | ||
| ] | ||
| } | ||
| }, | ||
| "properties": { | ||
| "target": { | ||
| "description": "Link to invoke action", | ||
| "format": "uri-reference", | ||
| "type": "string" | ||
| }, | ||
| "title": { | ||
| "description": "Friendly action name", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "OwningEntity": "OpenBMC", | ||
| "release": "1.0", | ||
| "title": "#OemBmcPairing.v1_0_0" | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,7 @@ schemas = [ | |
| 'IBMPCIeDevice', | ||
| 'IBMPCIeSlots', | ||
| 'IBMServiceRoot', | ||
| 'OemBmcPairing', | ||
| 'OemUpdateService', | ||
| ] | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is meant here by "names of BMCs"? Is this a Redfish link, DBus object path?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. It is a unique identifier for BMC(String) . In our case it will be "peer" and "self". This will be passed as argument for pairing action.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For clarity I think the long description should specify this level of detail.