yaml: format with prettier
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I193f690f3612fe72ec69030f81f4d5096a761601
diff --git a/.prettierrc.yaml b/.prettierrc.yaml
new file mode 100644
index 0000000..f07fbdd
--- /dev/null
+++ b/.prettierrc.yaml
@@ -0,0 +1,3 @@
+tabWidth: 2
+overrides:
+ - { "files": "*.yaml", "options": { "tabWidth": 4 } }
diff --git a/yaml/com/google/gbmc/Hoth.errors.yaml b/yaml/com/google/gbmc/Hoth.errors.yaml
index c697f93..76b4d7a 100644
--- a/yaml/com/google/gbmc/Hoth.errors.yaml
+++ b/yaml/com/google/gbmc/Hoth.errors.yaml
@@ -10,4 +10,3 @@
description: A system error occured with the Hoth interface.
- name: ExpectedInfoNotFound
description: Could not find the expected information in the response.
-
diff --git a/yaml/com/google/gbmc/Hoth.interface.yaml b/yaml/com/google/gbmc/Hoth.interface.yaml
index c15daf5..429f01d 100644
--- a/yaml/com/google/gbmc/Hoth.interface.yaml
+++ b/yaml/com/google/gbmc/Hoth.interface.yaml
@@ -1,294 +1,294 @@
description: >
- Implement the Hoth command control interface.
+ Implement the Hoth command control interface.
methods:
- - name: SendHostCommand
- description: >
- Send a host command to Hoth and return the response.
- This will block on Hoth completing its internal operations.
- Critical host commands like LoadTokens are banned.
- This method should be called from the IPMI HostCommand passthrough.
- parameters:
- - name: Command
- type: array[byte]
- description: >
- Data to write to Hoth SPI host command offset.
- returns:
- - name: Response
- type: array[byte]
- description: >
- Data read from Hoth SPI host command offset.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
- - xyz.openbmc_project.Common.Error.Timeout
+ - name: SendHostCommand
+ description: >
+ Send a host command to Hoth and return the response.
+ This will block on Hoth completing its internal operations.
+ Critical host commands like LoadTokens are banned.
+ This method should be called from the IPMI HostCommand passthrough.
+ parameters:
+ - name: Command
+ type: array[byte]
+ description: >
+ Data to write to Hoth SPI host command offset.
+ returns:
+ - name: Response
+ type: array[byte]
+ description: >
+ Data read from Hoth SPI host command offset.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
+ - xyz.openbmc_project.Common.Error.Timeout
- - name: SendTrustedHostCommand
- description: >
- Send a host command to Hoth and return the response.
- This will block on Hoth completing its internal operations.
- Critical host commands like LoadTokens are allowed.
- This method should be called from the BMC.
- parameters:
- - name: Command
- type: array[byte]
- description: >
- Data to write to Hoth SPI host command offset.
- returns:
- - name: Response
- type: array[byte]
- description: >
- Data read from Hoth SPI host command offset.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
- - xyz.openbmc_project.Common.Error.Timeout
+ - name: SendTrustedHostCommand
+ description: >
+ Send a host command to Hoth and return the response.
+ This will block on Hoth completing its internal operations.
+ Critical host commands like LoadTokens are allowed.
+ This method should be called from the BMC.
+ parameters:
+ - name: Command
+ type: array[byte]
+ description: >
+ Data to write to Hoth SPI host command offset.
+ returns:
+ - name: Response
+ type: array[byte]
+ description: >
+ Data read from Hoth SPI host command offset.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
+ - xyz.openbmc_project.Common.Error.Timeout
- - name: SendHostCommandAsync
- description: >
- Send a host command to Hoth and immediately return without waiting for
- response. Caller can either poll with calls to GetHostCommandResponse
- until retrieving the response, or wait for a ResponseReady signal.
- parameters:
- - name: Command
- type: array[byte]
- description: >
- Data to write to Hoth SPI host command offset.
- returns:
- - name: CallToken
- type: uint64
- description: >
- The representation for the call made
- errors:
- - self.Error.CommandFailure
+ - name: SendHostCommandAsync
+ description: >
+ Send a host command to Hoth and immediately return without waiting for
+ response. Caller can either poll with calls to GetHostCommandResponse
+ until retrieving the response, or wait for a ResponseReady signal.
+ parameters:
+ - name: Command
+ type: array[byte]
+ description: >
+ Data to write to Hoth SPI host command offset.
+ returns:
+ - name: CallToken
+ type: uint64
+ description: >
+ The representation for the call made
+ errors:
+ - self.Error.CommandFailure
- - name: GetHostCommandResponse
- description: >
- Read the response from Hoth mailbox.
- parameters:
- - name: CallToken
- type: uint64
- description: >
- The token returned from SendHostCommandAsync()
- returns:
- - name: Response
- type: array[byte]
- description: >
- Data read from Hoth SPI host command offset
- errors:
- - self.Error.ResponseFailure
- - self.Error.ResponseNotFound
- - self.Error.InterfaceError
+ - name: GetHostCommandResponse
+ description: >
+ Read the response from Hoth mailbox.
+ parameters:
+ - name: CallToken
+ type: uint64
+ description: >
+ The token returned from SendHostCommandAsync()
+ returns:
+ - name: Response
+ type: array[byte]
+ description: >
+ Data read from Hoth SPI host command offset
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ResponseNotFound
+ - self.Error.InterfaceError
- - name: UpdateFirmware
- description: >
- Write given firmware data to the Hoth firmware partition in EEPROM.
- parameters:
- - name: FirmwareData
- type: array[byte]
- description: >
- Hoth firmware image
- errors:
- - self.Error.FirmwareFailure
+ - name: UpdateFirmware
+ description: >
+ Write given firmware data to the Hoth firmware partition in EEPROM.
+ parameters:
+ - name: FirmwareData
+ type: array[byte]
+ description: >
+ Hoth firmware image
+ errors:
+ - self.Error.FirmwareFailure
- - name: GetFirmwareUpdateStatus
- description: >
- Get the status of the firmware update process.
- returns:
- - name: Status
- type: enum[self.FirmwareUpdateStatus]
- description: >
- Status of the firmware update
+ - name: GetFirmwareUpdateStatus
+ description: >
+ Get the status of the firmware update process.
+ returns:
+ - name: Status
+ type: enum[self.FirmwareUpdateStatus]
+ description: >
+ Status of the firmware update
- - name: InitiatePayload
- description: >
- Initiates erasure of the EEPROM staging area. Note that this will lock up
- access to Hoth for an extended time and may go over the kernel's SPI
- write timeout. Calling multiple small ErasePayload is recommended.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: InitiatePayload
+ description: >
+ Initiates erasure of the EEPROM staging area. Note that this will lock up
+ access to Hoth for an extended time and may go over the kernel's SPI
+ write timeout. Calling multiple small ErasePayload is recommended.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: GetInitiatePayloadStatus
- description: >
- Get the status of the payload initiation process.
- returns:
- - name: Status
- type: enum[self.FirmwareUpdateStatus]
- description: >
- Status of the payload initiation
+ - name: GetInitiatePayloadStatus
+ description: >
+ Get the status of the payload initiation process.
+ returns:
+ - name: Status
+ type: enum[self.FirmwareUpdateStatus]
+ description: >
+ Status of the payload initiation
- - name: ErasePayload
- description: >
- Erases the given size starting at the specified offset of the staging
- partition.
- parameters:
- - name: Offset
- type: uint32
- description: >
- Offset of the staging partition to start erasing from.
- - name: Size
- type: uint32
- description: >
- Size of the staging partition to erase.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: ErasePayload
+ description: >
+ Erases the given size starting at the specified offset of the staging
+ partition.
+ parameters:
+ - name: Offset
+ type: uint32
+ description: >
+ Offset of the staging partition to start erasing from.
+ - name: Size
+ type: uint32
+ description: >
+ Size of the staging partition to erase.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: SendPayload
- description: >
- Chunk and send the binary specified in the image path
- parameters:
- - name: ImagePath
- type: string
- description: >
- Firmware image path
- errors:
- - self.Error.FirmwareFailure
- - self.Error.InterfaceError
+ - name: SendPayload
+ description: >
+ Chunk and send the binary specified in the image path
+ parameters:
+ - name: ImagePath
+ type: string
+ description: >
+ Firmware image path
+ errors:
+ - self.Error.FirmwareFailure
+ - self.Error.InterfaceError
- - name: GetSendPayloadStatus
- description: >
- Get the status of the send payload process.
- returns:
- - name: Status
- type: enum[self.FirmwareUpdateStatus]
- description: >
- Status of the send payload process.
+ - name: GetSendPayloadStatus
+ description: >
+ Get the status of the send payload process.
+ returns:
+ - name: Status
+ type: enum[self.FirmwareUpdateStatus]
+ description: >
+ Status of the send payload process.
- - name: VerifyPayload
- description: >
- Initiates the verification process without activating the staging area
- errors:
- - self.Error.InterfaceError
+ - name: VerifyPayload
+ description: >
+ Initiates the verification process without activating the staging area
+ errors:
+ - self.Error.InterfaceError
- - name: GetVerifyPayloadStatus
- description: >
- Get the status of the payload verification process.
- returns:
- - name: Status
- type: enum[self.FirmwareUpdateStatus]
- description: >
- Status of the payload verification
+ - name: GetVerifyPayloadStatus
+ description: >
+ Get the status of the payload verification process.
+ returns:
+ - name: Status
+ type: enum[self.FirmwareUpdateStatus]
+ description: >
+ Status of the payload verification
- - name: ActivatePayload
- description: >
- Activates the staging area as persistent or non-persistent for next boot
- if verification was successful.
- parameters:
- - name: MakePersistent
- type: boolean
- description: >
- Flag to determine whether to activate the staged image as persistent
- or non-persistent for next boot.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: ActivatePayload
+ description: >
+ Activates the staging area as persistent or non-persistent for next boot
+ if verification was successful.
+ parameters:
+ - name: MakePersistent
+ type: boolean
+ description: >
+ Flag to determine whether to activate the staged image as persistent
+ or non-persistent for next boot.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: GetPayloadSize
- description: >
- Determines the max size of the payload region.
- returns:
- - name: Size
- type: uint32
- description: >
- The size of the payload region
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: GetPayloadSize
+ description: >
+ Determines the max size of the payload region.
+ returns:
+ - name: Size
+ type: uint32
+ description: >
+ The size of the payload region
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: Confirm
- description: >
- Prevents hoth from rolling back and using the previous image.
- When an image can be comfirmed to be working well, this command is given,
- which disarms the hoth watchdog.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: Confirm
+ description: >
+ Prevents hoth from rolling back and using the previous image.
+ When an image can be comfirmed to be working well, this command is given,
+ which disarms the hoth watchdog.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: GetTotalBootTime
- description: >
- Get total time spending from reset to HVNGOOD.
- returns:
- - name: Time
- type: uint32
- description: >
- Time in microseconds.
- errors:
- - self.Error.ResponseFailure
- - self.Error.ExpectedInfoNotFound
+ - name: GetTotalBootTime
+ description: >
+ Get total time spending from reset to HVNGOOD.
+ returns:
+ - name: Time
+ type: uint32
+ description: >
+ Time in microseconds.
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ExpectedInfoNotFound
- - name: GetFirmwareUpdateTime
- description: >
- Get time spending in the self update routine. Since a proper self update
- involves a reset, this time is always expected to be low.
- returns:
- - name: Time
- type: uint32
- description: >
- Time in microseconds.
- errors:
- - self.Error.ResponseFailure
- - self.Error.ExpectedInfoNotFound
+ - name: GetFirmwareUpdateTime
+ description: >
+ Get time spending in the self update routine. Since a proper self update
+ involves a reset, this time is always expected to be low.
+ returns:
+ - name: Time
+ type: uint32
+ description: >
+ Time in microseconds.
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ExpectedInfoNotFound
- - name: GetFirmwareMirroringTime
- description: >
- Get time spending in mirroing the self-update. This time is a reasonable
- proxy for the total self update time.
- returns:
- - name: Time
- type: uint32
- description: >
- Time in microseconds.
- errors:
- - self.Error.ResponseFailure
- - self.Error.ExpectedInfoNotFound
+ - name: GetFirmwareMirroringTime
+ description: >
+ Get time spending in mirroing the self-update. This time is a reasonable
+ proxy for the total self update time.
+ returns:
+ - name: Time
+ type: uint32
+ description: >
+ Time in microseconds.
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ExpectedInfoNotFound
- - name: GetPayloadValidationTime
- description: >
- Get time spending in validating the payload, copying mutable regions and/or
- dealing with failsafe fallback.
- returns:
- - name: Time
- type: uint32
- description: >
- Time in microseconds.
- errors:
- - self.Error.ResponseFailure
- - self.Error.ExpectedInfoNotFound
+ - name: GetPayloadValidationTime
+ description: >
+ Get time spending in validating the payload, copying mutable regions and/or
+ dealing with failsafe fallback.
+ returns:
+ - name: Time
+ type: uint32
+ description: >
+ Time in microseconds.
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ExpectedInfoNotFound
signals:
- - name: HostCommandResponseReady
- description: >
- This signal is broadcast when a response is ready for the call that
- returned CallToken.
- properties:
- - name: CallToken
- type: uint64
- description: >
- The token returned from SendHostCommandAsync()
+ - name: HostCommandResponseReady
+ description: >
+ This signal is broadcast when a response is ready for the call that
+ returned CallToken.
+ properties:
+ - name: CallToken
+ type: uint64
+ description: >
+ The token returned from SendHostCommandAsync()
enumerations:
- - name: FirmwareUpdateStatus
- description: >
- The status of a firmware update through hothd
- values:
- - name: 'None'
- description: >
- No update initiated
- - name: 'InProgress'
- description: >
- Update still in progress
- - name: 'Error'
- description: >
- Update has failed
- - name: 'Done'
- description: >
- Update has completed successfully
+ - name: FirmwareUpdateStatus
+ description: >
+ The status of a firmware update through hothd
+ values:
+ - name: "None"
+ description: >
+ No update initiated
+ - name: "InProgress"
+ description: >
+ Update still in progress
+ - name: "Error"
+ description: >
+ Update has failed
+ - name: "Done"
+ description: >
+ Update has completed successfully
diff --git a/yaml/com/ibm/Dump/Create.interface.yaml b/yaml/com/ibm/Dump/Create.interface.yaml
index c5cf772..847b64a 100644
--- a/yaml/com/ibm/Dump/Create.interface.yaml
+++ b/yaml/com/ibm/Dump/Create.interface.yaml
@@ -8,36 +8,36 @@
description: >
Additional parameters for creating the dump.
values:
- - name: 'VSPString'
- description: >
- The resouce dump is collected from various host resources.
- The resource to collect the dump is indicated by using the
- resource selector.
- The resource selector string needs to be passed to host to
- generate a resource dump.
- - name: 'Password'
- description: >
- The password for authenticating the resource dump request.
- - name: 'ErrorLogId'
- description: >
- The id of the log associated with action which triggered the
- dump. The value should be a 32 bit unsigned integer.
- - name: 'DumpType'
- description: >
- Type of the dump to be collected
- - name: 'FailingUnitId'
- description: >
- A unique id of failing hardware unit which is causing the dump.
- The value should be a 32 bit unsigned integer.
+ - name: "VSPString"
+ description: >
+ The resouce dump is collected from various host resources.
+ The resource to collect the dump is indicated by using the
+ resource selector.
+ The resource selector string needs to be passed to host to
+ generate a resource dump.
+ - name: "Password"
+ description: >
+ The password for authenticating the resource dump request.
+ - name: "ErrorLogId"
+ description: >
+ The id of the log associated with action which triggered the
+ dump. The value should be a 32 bit unsigned integer.
+ - name: "DumpType"
+ description: >
+ Type of the dump to be collected
+ - name: "FailingUnitId"
+ description: >
+ A unique id of failing hardware unit which is causing the dump.
+ The value should be a 32 bit unsigned integer.
- name: DumpType
description: >
Type of the host dump to be collected.
values:
- - name: 'Hostboot'
- description: >
- Hostboot dump is collected during a boot failure during the
- hostboot booting phase.
- - name: 'Hardware'
- desription: >
- Hardware dump is collected during a system checkstop.
+ - name: "Hostboot"
+ description: >
+ Hostboot dump is collected during a boot failure during the
+ hostboot booting phase.
+ - name: "Hardware"
+ desription: >
+ Hardware dump is collected during a system checkstop.
diff --git a/yaml/com/ibm/Dump/Entry/Resource.interface.yaml b/yaml/com/ibm/Dump/Entry/Resource.interface.yaml
index da5332f..17a38d9 100644
--- a/yaml/com/ibm/Dump/Entry/Resource.interface.yaml
+++ b/yaml/com/ibm/Dump/Entry/Resource.interface.yaml
@@ -23,4 +23,3 @@
type: string
description: >
The password required by host to validate the request.
-
diff --git a/yaml/com/ibm/Logging/Policy.interface.yaml b/yaml/com/ibm/Logging/Policy.interface.yaml
index de83d86..2dc6d05 100644
--- a/yaml/com/ibm/Logging/Policy.interface.yaml
+++ b/yaml/com/ibm/Logging/Policy.interface.yaml
@@ -1,5 +1,5 @@
description: >
- Implement to provide IBM specific error log policy attributes.
+ Implement to provide IBM specific error log policy attributes.
properties:
- name: EventID
type: string
diff --git a/yaml/com/ibm/VPD.errors.yaml b/yaml/com/ibm/VPD.errors.yaml
index ee4b735..a69e8c1 100644
--- a/yaml/com/ibm/VPD.errors.yaml
+++ b/yaml/com/ibm/VPD.errors.yaml
@@ -10,15 +10,15 @@
description: Keyword is not found.
- name: BlankSystemVPD
description: System VPD is blank on both hardware and cache.
- On IBM systems, certain VPD data must be available
- for the system to boot. This error is used to
- indicate that no valid data was found by the BMC.
+ On IBM systems, certain VPD data must be available
+ for the system to boot. This error is used to
+ indicate that no valid data was found by the BMC.
- name: InvalidEepromPath
description: EEPROM path is invalid. Parser failed to access the
- path.
+ path.
- name: InvalidVPD
description: VPD file is not valid. Mandatory records are missing
- in VPD file.
+ in VPD file.
- name: EccCheckFailed
desciption: Invalid VPD data. Ecc check for the data failed.
- name: InvalidJson
diff --git a/yaml/com/ibm/VPD/Manager.interface.yaml b/yaml/com/ibm/VPD/Manager.interface.yaml
index 179283a..ddeacd4 100644
--- a/yaml/com/ibm/VPD/Manager.interface.yaml
+++ b/yaml/com/ibm/VPD/Manager.interface.yaml
@@ -5,72 +5,72 @@
description: >
A method to update the keyword value for a given VPD record.
parameters:
- - name: path
- type: path
- description: >
- Path to the D-Bus object that represents the FRU.
- - name: record
- type: string
- description: >
- Record whose keyword value needs to be modified.
- - name: keyword
- type: string
- description: >
- Keyword whose value needs to be updated.
- - name: value
- type: array[byte]
- description: >
- Value to be updated for the keyword.
+ - name: path
+ type: path
+ description: >
+ Path to the D-Bus object that represents the FRU.
+ - name: record
+ type: string
+ description: >
+ Record whose keyword value needs to be modified.
+ - name: keyword
+ type: string
+ description: >
+ Keyword whose value needs to be updated.
+ - name: value
+ type: array[byte]
+ description: >
+ Value to be updated for the keyword.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - com.ibm.VPD.Error.PathNotFound
- - com.ibm.VPD.Error.RecordNotFound
- - com.ibm.VPD.Error.KeywordNotFound
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - com.ibm.VPD.Error.PathNotFound
+ - com.ibm.VPD.Error.RecordNotFound
+ - com.ibm.VPD.Error.KeywordNotFound
- name: GetFRUsByUnexpandedLocationCode
description: >
A method to get list of FRU D-BUS object paths for a given
unexpanded location code.
parameters:
- - name: locationCode
- type: string
- description: >
- An un-expanded Location code.
- - name: nodeNumber
- type: uint16
- description: >
- Denotes the node in case of a multi-node configuration,
- ignored on a single node system.
+ - name: locationCode
+ type: string
+ description: >
+ An un-expanded Location code.
+ - name: nodeNumber
+ type: uint16
+ description: >
+ Denotes the node in case of a multi-node configuration,
+ ignored on a single node system.
returns:
- - name: inventoryList
- type: array[path]
- description: >
- List of all the FRUs D-Bus object paths for the given location
- code.
+ - name: inventoryList
+ type: array[path]
+ description: >
+ List of all the FRUs D-Bus object paths for the given location
+ code.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - com.ibm.VPD.Error.LocationNotFound
- - com.ibm.VPD.Error.NodeNotFound
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - com.ibm.VPD.Error.LocationNotFound
+ - com.ibm.VPD.Error.NodeNotFound
- name: GetFRUsByExpandedLocationCode
description: >
A method to get list of FRU D-BUS object paths for a given expanded
location code.
parameters:
- - name: locationCode
- type: string
- description: >
- Location code in expanded format.
+ - name: locationCode
+ type: string
+ description: >
+ Location code in expanded format.
returns:
- - name: inventoryList
- type: array[path]
- description: >
- List of all the FRUs D-Bus object path for the given location
- code.
+ - name: inventoryList
+ type: array[path]
+ description: >
+ List of all the FRUs D-Bus object path for the given location
+ code.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - com.ibm.VPD.Error.LocationNotFound
- - com.ibm.VPD.Error.NodeNotFound
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - com.ibm.VPD.Error.LocationNotFound
+ - com.ibm.VPD.Error.NodeNotFound
- name: GetExpandedLocationCode
description: >
@@ -78,28 +78,28 @@
un-expanded location code.
Expanded location codes gives the location of the FRU in the system.
parameters:
- - name: locationCode
- type: string
- description: >
- Location code in un-expanded format.
- - name: nodeNumber
- type: uint16
- description: >
- Denotes the node in case of multi-node configuration.
- Ignored in case of single node configuration.
+ - name: locationCode
+ type: string
+ description: >
+ Location code in un-expanded format.
+ - name: nodeNumber
+ type: uint16
+ description: >
+ Denotes the node in case of multi-node configuration.
+ Ignored in case of single node configuration.
returns:
- - name: locationCode
- type: string
- description: >
- Location code in expanded format.
+ - name: locationCode
+ type: string
+ description: >
+ Location code in expanded format.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - com.ibm.VPD.Error.LocationNotFound
- - com.ibm.VPD.Error.NodeNotFound
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - com.ibm.VPD.Error.LocationNotFound
+ - com.ibm.VPD.Error.NodeNotFound
- name: PerformVPDRecollection
description: >
An api to check for FRUs replaced and if required, perform
recollection of VPD data for them.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InvalidArgument
diff --git a/yaml/com/ibm/ipzvpd/CP00.interface.yaml b/yaml/com/ibm/ipzvpd/CP00.interface.yaml
index 0ec995b..bbc5652 100644
--- a/yaml/com/ibm/ipzvpd/CP00.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/CP00.interface.yaml
@@ -50,4 +50,3 @@
type: array[byte]
description: >
D5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/DINF.interface.yaml b/yaml/com/ibm/ipzvpd/DINF.interface.yaml
index 619ae15..db19377 100644
--- a/yaml/com/ibm/ipzvpd/DINF.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/DINF.interface.yaml
@@ -13,4 +13,3 @@
type: array[byte]
description: >
FL keyword. The FRU label.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP0.interface.yaml b/yaml/com/ibm/ipzvpd/LRP0.interface.yaml
index cd2f360..efcd913 100644
--- a/yaml/com/ibm/ipzvpd/LRP0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP0.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP1.interface.yaml b/yaml/com/ibm/ipzvpd/LRP1.interface.yaml
index e02320b..63f2650 100644
--- a/yaml/com/ibm/ipzvpd/LRP1.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP1.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP2.interface.yaml b/yaml/com/ibm/ipzvpd/LRP2.interface.yaml
index 9657386..e4818c2 100644
--- a/yaml/com/ibm/ipzvpd/LRP2.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP2.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP3.interface.yaml b/yaml/com/ibm/ipzvpd/LRP3.interface.yaml
index d8ce8d2..8889788 100644
--- a/yaml/com/ibm/ipzvpd/LRP3.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP3.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP4.interface.yaml b/yaml/com/ibm/ipzvpd/LRP4.interface.yaml
index 69d0799..371eca5 100644
--- a/yaml/com/ibm/ipzvpd/LRP4.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP4.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP5.interface.yaml b/yaml/com/ibm/ipzvpd/LRP5.interface.yaml
index 8d369dd..a883ecf 100644
--- a/yaml/com/ibm/ipzvpd/LRP5.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP5.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP6.interface.yaml b/yaml/com/ibm/ipzvpd/LRP6.interface.yaml
index 2ba871b..ede98ac 100644
--- a/yaml/com/ibm/ipzvpd/LRP6.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP6.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP7.interface.yaml b/yaml/com/ibm/ipzvpd/LRP7.interface.yaml
index b9e3921..60b4a5b 100644
--- a/yaml/com/ibm/ipzvpd/LRP7.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP7.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP0.interface.yaml b/yaml/com/ibm/ipzvpd/LWP0.interface.yaml
index 9fc846e..6f940e0 100644
--- a/yaml/com/ibm/ipzvpd/LWP0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP0.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP1.interface.yaml b/yaml/com/ibm/ipzvpd/LWP1.interface.yaml
index 784820f..61684fc 100644
--- a/yaml/com/ibm/ipzvpd/LWP1.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP1.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP2.interface.yaml b/yaml/com/ibm/ipzvpd/LWP2.interface.yaml
index 9a43d9b..370e4c4 100644
--- a/yaml/com/ibm/ipzvpd/LWP2.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP2.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP3.interface.yaml b/yaml/com/ibm/ipzvpd/LWP3.interface.yaml
index 1b2f6e4..45d249e 100644
--- a/yaml/com/ibm/ipzvpd/LWP3.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP3.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP4.interface.yaml b/yaml/com/ibm/ipzvpd/LWP4.interface.yaml
index 972a392..1be2dfb 100644
--- a/yaml/com/ibm/ipzvpd/LWP4.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP4.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP5.interface.yaml b/yaml/com/ibm/ipzvpd/LWP5.interface.yaml
index 717ae05..5021565 100644
--- a/yaml/com/ibm/ipzvpd/LWP5.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP5.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP6.interface.yaml b/yaml/com/ibm/ipzvpd/LWP6.interface.yaml
index dbb7f9c..e45f3b3 100644
--- a/yaml/com/ibm/ipzvpd/LWP6.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP6.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP7.interface.yaml b/yaml/com/ibm/ipzvpd/LWP7.interface.yaml
index db456f1..4b88827 100644
--- a/yaml/com/ibm/ipzvpd/LWP7.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP7.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LXR0.interface.yaml b/yaml/com/ibm/ipzvpd/LXR0.interface.yaml
index d1409ec..ac3d3cc 100644
--- a/yaml/com/ibm/ipzvpd/LXR0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LXR0.interface.yaml
@@ -13,4 +13,3 @@
type: array[byte]
description: >
LX keyword. The load ID data.
-
diff --git a/yaml/com/ibm/ipzvpd/Location.interface.yaml b/yaml/com/ibm/ipzvpd/Location.interface.yaml
index b5a83a7..c64e7a8 100644
--- a/yaml/com/ibm/ipzvpd/Location.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/Location.interface.yaml
@@ -6,4 +6,3 @@
description: >
A string describing the physical location of the FRU.
The location is determined based on the system design.
-
diff --git a/yaml/com/ibm/ipzvpd/MER0.interface.yaml b/yaml/com/ibm/ipzvpd/MER0.interface.yaml
index 67d3797..f9e472b 100644
--- a/yaml/com/ibm/ipzvpd/MER0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/MER0.interface.yaml
@@ -10,4 +10,3 @@
type: array[byte]
description: >
The "#I" keyword. Contains the repair data.
-
diff --git a/yaml/com/ibm/ipzvpd/UTIL.interface.yaml b/yaml/com/ibm/ipzvpd/UTIL.interface.yaml
index 31b655d..a51c747 100644
--- a/yaml/com/ibm/ipzvpd/UTIL.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/UTIL.interface.yaml
@@ -86,4 +86,3 @@
type: array[byte]
description: >
F9 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/VCEN.interface.yaml b/yaml/com/ibm/ipzvpd/VCEN.interface.yaml
index 9a412c2..97ab017 100644
--- a/yaml/com/ibm/ipzvpd/VCEN.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VCEN.interface.yaml
@@ -29,4 +29,3 @@
type: array[byte]
description: >
RB keyword. Brand specific data.
-
diff --git a/yaml/com/ibm/ipzvpd/VCFG.interface.yaml b/yaml/com/ibm/ipzvpd/VCFG.interface.yaml
index 5021fe6..1e19926 100644
--- a/yaml/com/ibm/ipzvpd/VCFG.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VCFG.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
Second base MAC address.
-
diff --git a/yaml/com/ibm/ipzvpd/VEIR.interface.yaml b/yaml/com/ibm/ipzvpd/VEIR.interface.yaml
index 115ccdd..28843f5 100644
--- a/yaml/com/ibm/ipzvpd/VEIR.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VEIR.interface.yaml
@@ -10,4 +10,3 @@
type: array[byte]
description: >
The "#I" keyword. Contains the repair data.
-
diff --git a/yaml/com/ibm/ipzvpd/VER0.interface.yaml b/yaml/com/ibm/ipzvpd/VER0.interface.yaml
index d5869e9..1c0d3c8 100644
--- a/yaml/com/ibm/ipzvpd/VER0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VER0.interface.yaml
@@ -10,4 +10,3 @@
type: array[byte]
description: >
The "#I" keyword. Contains the repair data.
-
diff --git a/yaml/com/ibm/ipzvpd/VMPU.interface.yaml b/yaml/com/ibm/ipzvpd/VMPU.interface.yaml
index fb14fd0..97ebf97 100644
--- a/yaml/com/ibm/ipzvpd/VMPU.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VMPU.interface.yaml
@@ -21,4 +21,3 @@
type: array[byte]
description: >
IN Keyword. Multi purpose usage data.
-
diff --git a/yaml/com/ibm/ipzvpd/VMSC.interface.yaml b/yaml/com/ibm/ipzvpd/VMSC.interface.yaml
index 04865f9..4e19656 100644
--- a/yaml/com/ibm/ipzvpd/VMSC.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VMSC.interface.yaml
@@ -9,4 +9,3 @@
type: array[byte]
description: >
IN keyword. Multi purpose usage data.
-
diff --git a/yaml/com/ibm/ipzvpd/VPRI.interface.yaml b/yaml/com/ibm/ipzvpd/VPRI.interface.yaml
index 21fbfc6..f5360d9 100644
--- a/yaml/com/ibm/ipzvpd/VPRI.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VPRI.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
'#D' keyword. Card specific data.
-
diff --git a/yaml/com/ibm/ipzvpd/VR10.interface.yaml b/yaml/com/ibm/ipzvpd/VR10.interface.yaml
index fdde378..ae2d879 100644
--- a/yaml/com/ibm/ipzvpd/VR10.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VR10.interface.yaml
@@ -21,4 +21,3 @@
type: array[byte]
description: >
WA keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/VRTN.interface.yaml b/yaml/com/ibm/ipzvpd/VRTN.interface.yaml
index 005e224..4bf56fe 100644
--- a/yaml/com/ibm/ipzvpd/VRTN.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VRTN.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
I2 keyword. Multi purpose data.
-
diff --git a/yaml/com/ibm/ipzvpd/VSBP.interface.yaml b/yaml/com/ibm/ipzvpd/VSBP.interface.yaml
index c7487ca..1f81914 100644
--- a/yaml/com/ibm/ipzvpd/VSBP.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VSBP.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
A unique keyword to identify the system.
-
diff --git a/yaml/com/ibm/ipzvpd/VSRC.interface.yaml b/yaml/com/ibm/ipzvpd/VSRC.interface.yaml
index cb0d46b..6a5bb97 100644
--- a/yaml/com/ibm/ipzvpd/VSRC.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VSRC.interface.yaml
@@ -13,4 +13,3 @@
type: array[byte]
description: >
IN keyword. FRU plug history data.
-
diff --git a/yaml/com/ibm/ipzvpd/VSYS.interface.yaml b/yaml/com/ibm/ipzvpd/VSYS.interface.yaml
index 83b22ff..b15a0a8 100644
--- a/yaml/com/ibm/ipzvpd/VSYS.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VSYS.interface.yaml
@@ -61,4 +61,3 @@
type: array[byte]
description: >
Firmware version.
-
diff --git a/yaml/com/ibm/ipzvpd/VW10.interface.yaml b/yaml/com/ibm/ipzvpd/VW10.interface.yaml
index fe165ac..aac4aed 100644
--- a/yaml/com/ibm/ipzvpd/VW10.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VW10.interface.yaml
@@ -13,4 +13,3 @@
type: array[byte]
description: >
Gard data.
-
diff --git a/yaml/com/intel/Protocol/PECI/Raw.interface.yaml b/yaml/com/intel/Protocol/PECI/Raw.interface.yaml
index 9b8d071..f2fdb34 100644
--- a/yaml/com/intel/Protocol/PECI/Raw.interface.yaml
+++ b/yaml/com/intel/Protocol/PECI/Raw.interface.yaml
@@ -6,20 +6,20 @@
description: >
Send raw PECI command(s) to the CPU
parameters:
- - name: device
- type: string
- description: >
- The path for the PECI device to use for the command
- - name: commands
- type: array[array[byte]]
- description: >
- An array of byte arrays where each byte array holds the raw
- bytes for a single PECI command. The larger array allows
- sending multiple PECI commands in a single transaction.
+ - name: device
+ type: string
+ description: >
+ The path for the PECI device to use for the command
+ - name: commands
+ type: array[array[byte]]
+ description: >
+ An array of byte arrays where each byte array holds the raw
+ bytes for a single PECI command. The larger array allows
+ sending multiple PECI commands in a single transaction.
returns:
- - name: results
- type: array[array[byte]]
- description: >
- An array of byte arrays where each byte array holds the raw
- bytes for a single PECI response corresponding to the command
- in the command array.
+ - name: results
+ type: array[array[byte]]
+ description: >
+ An array of byte arrays where each byte array holds the raw
+ bytes for a single PECI response corresponding to the command
+ in the command array.
diff --git a/yaml/org/freedesktop/UPower/Device.interface.yaml b/yaml/org/freedesktop/UPower/Device.interface.yaml
index 9f13d61..cb1ef82 100644
--- a/yaml/org/freedesktop/UPower/Device.interface.yaml
+++ b/yaml/org/freedesktop/UPower/Device.interface.yaml
@@ -17,50 +17,50 @@
"Gets history for the power device that is persistent across
reboots."
parameters:
- - name: type
- type: string
- description: >
- "The type of history. Valid types are rate or charge."
- - name: timespan
- type: uint32
- description: >
- "The amount of data to return in seconds, or 0 for all."
- - name: resolution
- type: uint32
- description: >
- "The approximate number of points to return. A higher resolution is
- more accurate, at the expense of plotting speed."
+ - name: type
+ type: string
+ description: >
+ "The type of history. Valid types are rate or charge."
+ - name: timespan
+ type: uint32
+ description: >
+ "The amount of data to return in seconds, or 0 for all."
+ - name: resolution
+ type: uint32
+ description: >
+ "The approximate number of points to return. A higher resolution is
+ more accurate, at the expense of plotting speed."
returns:
- - name: data
- type: array[struct[uint32, double, uint32]]
- description: >
- "The history data for the power device, if the device supports
- history. Data is ordered from the earliest in time, to the newest
- data point. Each element contains the following members:
- time: The time value in seconds from the gettimeofday() method.
- value: The data value, for instance the rate in W or the charge
- in %.
- state: The state of the device, for instance charging or
- discharging."
+ - name: data
+ type: array[struct[uint32, double, uint32]]
+ description: >
+ "The history data for the power device, if the device supports
+ history. Data is ordered from the earliest in time, to the newest
+ data point. Each element contains the following members:
+ time: The time value in seconds from the gettimeofday() method.
+ value: The data value, for instance the rate in W or the charge
+ in %.
+ state: The state of the device, for instance charging or
+ discharging."
- name: GetStatistics
description: >
"Gets statistics for the power device that may be interesting to show
on a graph in the session."
parameters:
- - name: type
- type: string
- description: >
- "The mode for the statistics. Valid types are charging or
- discharging."
+ - name: type
+ type: string
+ description: >
+ "The mode for the statistics. Valid types are charging or
+ discharging."
returns:
- - name: data
- type: array[struct[double, double]]
- description: >
- "The statistics data for the power device. Each element contains the
- following members:
- value: The value of the percentage point, usually in seconds.
- accuracy: The accuracy of the prediction in percent."
+ - name: data
+ type: array[struct[double, double]]
+ description: >
+ "The statistics data for the power device. Each element contains the
+ following members:
+ value: The value of the percentage point, usually in seconds.
+ accuracy: The accuracy of the prediction in percent."
properties:
- name: NativePath
diff --git a/yaml/org/open_power/Control/Host.interface.yaml b/yaml/org/open_power/Control/Host.interface.yaml
index ea5e9a1..86dcde1 100644
--- a/yaml/org/open_power/Control/Host.interface.yaml
+++ b/yaml/org/open_power/Control/Host.interface.yaml
@@ -23,33 +23,33 @@
signals:
- name: CommandComplete
description: >
- Signal indicating that a command has completed
+ Signal indicating that a command has completed
properties:
- - name: command
- type: enum[self.Command]
- description: Executed command
- - name: result
- type: enum[self.Result]
- description: Result of the command execution
+ - name: command
+ type: enum[self.Command]
+ description: Executed command
+ - name: result
+ type: enum[self.Result]
+ description: Result of the command execution
enumerations:
- name: Command
description: >
- The command to execute against the host
+ The command to execute against the host
values:
- - name: OCCReset
- description: >
- Host firmware should reset the OCC. This is invoked by
- OCC error monitor application on detecting the error.
- Sensor ID of the failing OCC will be sent as data.
- This command will return once the command has been placed
- in command Queue.
+ - name: OCCReset
+ description: >
+ Host firmware should reset the OCC. This is invoked by
+ OCC error monitor application on detecting the error.
+ Sensor ID of the failing OCC will be sent as data.
+ This command will return once the command has been placed
+ in command Queue.
- name: Result
description: >
- The result of the command execution
+ The result of the command execution
values:
- - name: Success
- description: Command execution was a success
- - name: Failure
- description: Command execution was a failure
+ - name: Success
+ description: Command execution was a success
+ - name: Failure
+ description: Command execution was a failure
diff --git a/yaml/org/open_power/Logging/PEL.interface.yaml b/yaml/org/open_power/Logging/PEL.interface.yaml
index bf7deb5..80fd0b1 100644
--- a/yaml/org/open_power/Logging/PEL.interface.yaml
+++ b/yaml/org/open_power/Logging/PEL.interface.yaml
@@ -1,162 +1,161 @@
description: >
- Provides D-Bus access to OpenPower Platform Event Logs
+ Provides D-Bus access to OpenPower Platform Event Logs
methods:
- - name: GetPEL
- description: >
- Returns a file desciptor to a PEL.
- parameters:
- - name: pelID
- type: uint32
- description: >
- The PEL log ID of the PEL to retrieve.
- returns:
- - name: data
- type: unixfd
- description: >
- A file descriptor for a file that contains the PEL.
- errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - name: GetPEL
+ description: >
+ Returns a file desciptor to a PEL.
+ parameters:
+ - name: pelID
+ type: uint32
+ description: >
+ The PEL log ID of the PEL to retrieve.
+ returns:
+ - name: data
+ type: unixfd
+ description: >
+ A file descriptor for a file that contains the PEL.
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- - name: GetPELFromOBMCID
- description: >
- Returns PEL data based on the OpenBMC event log ID.
- parameters:
- - name: obmcLogID
- type: uint32
- description: >
- The OpenBMC event log ID of the PEL to retrieve.
- returns:
- - name: data
- type: array[byte]
- description: >
- The PEL data
- errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - name: GetPELFromOBMCID
+ description: >
+ Returns PEL data based on the OpenBMC event log ID.
+ parameters:
+ - name: obmcLogID
+ type: uint32
+ description: >
+ The OpenBMC event log ID of the PEL to retrieve.
+ returns:
+ - name: data
+ type: array[byte]
+ description: >
+ The PEL data
+ errors:
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- - name: HostAck
- description: >
- Notifies the PEL handler that the host (usually the OS) acked a PEL.
- parameters:
- - name: pelID
- type: uint32
- description: >
- The PEL log ID
- errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - name: HostAck
+ description: >
+ Notifies the PEL handler that the host (usually the OS) acked a PEL.
+ parameters:
+ - name: pelID
+ type: uint32
+ description: >
+ The PEL log ID
+ errors:
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- - name: HostReject
- description: >
- Notifies the PEL handler that the host could not process a PEL.
- parameters:
- - name: pelID
- type: uint32
- description: >
- The PEL log ID
- - name: reason
- type: enum[self.RejectionReason]
- description: >
- The reason the PEL was rejected
- errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - name: HostReject
+ description: >
+ Notifies the PEL handler that the host could not process a PEL.
+ parameters:
+ - name: pelID
+ type: uint32
+ description: >
+ The PEL log ID
+ - name: reason
+ type: enum[self.RejectionReason]
+ description: >
+ The reason the PEL was rejected
+ errors:
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- - name: CreatePELWithFFDCFiles
- description: >
- Creates an OpenBMC event log and a corresponding PEL. This method
- returns the IDs of the created PEL and OpenBMC event log, unlike the
- 'xyz.openbmc_project.Logging.Create.CreateWithFFDCFiles' method which
- doesn't return anything.
- parameters:
- - name: Message
- type: string
- description: >
- The Message property of the OpenBMC event log entry.
- This is also the key into the PEL message registry.
- - name: Severity
- type: enum[xyz.openbmc_project.Logging.Entry.Level]
- description: >
- The Severity property of the event entry.
- - name: AdditionalData
- type: dict[string, string]
- description: >
- The AdditionalData property of the event entry.
- e.g.:
- {
- "key1": "value1",
- "key2": "value2"
- }
- ends up in AdditionaData like:
- ["KEY1=value1", "KEY2=value2"]
- - name: FFDC
- type: array[struct[enum[xyz.openbmc_project.Logging.Create.FFDCFormat], byte, byte, unixfd]]
- description: >
- File descriptors for any files containing FFDC, along with metadata
- about the contents:
+ - name: CreatePELWithFFDCFiles
+ description: >
+ Creates an OpenBMC event log and a corresponding PEL. This method
+ returns the IDs of the created PEL and OpenBMC event log, unlike the
+ 'xyz.openbmc_project.Logging.Create.CreateWithFFDCFiles' method which
+ doesn't return anything.
+ parameters:
+ - name: Message
+ type: string
+ description: >
+ The Message property of the OpenBMC event log entry.
+ This is also the key into the PEL message registry.
+ - name: Severity
+ type: enum[xyz.openbmc_project.Logging.Entry.Level]
+ description: >
+ The Severity property of the event entry.
+ - name: AdditionalData
+ type: dict[string, string]
+ description: >
+ The AdditionalData property of the event entry.
+ e.g.:
+ {
+ "key1": "value1",
+ "key2": "value2"
+ }
+ ends up in AdditionaData like:
+ ["KEY1=value1", "KEY2=value2"]
+ - name: FFDC
+ type: array[struct[enum[xyz.openbmc_project.Logging.Create.FFDCFormat], byte, byte, unixfd]]
+ description: >
+ File descriptors for any files containing FFDC, along with metadata
+ about the contents:
- FFDCFormat- The format type of the contained data.
- subType - The format subtype, used for the 'Custom' type.
- version - The version of the data format, used for the 'Custom'
- type.
- unixfd - The file descriptor to the data file.
+ FFDCFormat- The format type of the contained data.
+ subType - The format subtype, used for the 'Custom' type.
+ version - The version of the data format, used for the 'Custom'
+ type.
+ unixfd - The file descriptor to the data file.
- e.g.:
- [
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0, 5},
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2, 6}
- ]
- returns:
- - name: IDs
- type: struct[uint32, uint32]
- description: >
- The IDs of the 2 created logs:
- - OpenBMC event log ID
- - PEL log ID: The unique ID of the PEL
- Note that the PEL's platform log ID (PLID) field is always
- equal to the PEL log ID for BMC created PELs.
+ e.g.:
+ [
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0, 5},
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2, 6}
+ ]
+ returns:
+ - name: IDs
+ type: struct[uint32, uint32]
+ description: >
+ The IDs of the 2 created logs:
+ - OpenBMC event log ID
+ - PEL log ID: The unique ID of the PEL
+ Note that the PEL's platform log ID (PLID) field is always
+ equal to the PEL log ID for BMC created PELs.
- - name: GetPELIdFromBMCLogId
- description: >
- Returns the PEL Id (aka Entry ID (EID)) based on the
- given BMC event log id.
- parameters:
- - name: bmcLogId
- type: uint32
- description: >
- The BMC event log id of the PEL to retrieve the PEL id.
- returns:
- - name: pelId
- type: uint32
- description: >
- The Id of the PEL.
- errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - name: GetPELIdFromBMCLogId
+ description: >
+ Returns the PEL Id (aka Entry ID (EID)) based on the
+ given BMC event log id.
+ parameters:
+ - name: bmcLogId
+ type: uint32
+ description: >
+ The BMC event log id of the PEL to retrieve the PEL id.
+ returns:
+ - name: pelId
+ type: uint32
+ description: >
+ The Id of the PEL.
+ errors:
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- - name: GetBMCLogIdFromPELId
- description: >
- Returns the BMC event log id based on the given PEL id (aka
- Entry ID (EID)).
- parameters:
- - name: pelId
- type: uint32
- description: >
- The PEL id to retrieve the BMC event log id.
- returns:
- - name: bmcLogId
- type: uint32
- description: >
- The BMC event log id of the PEL.
- errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - name: GetBMCLogIdFromPELId
+ description: >
+ Returns the BMC event log id based on the given PEL id (aka
+ Entry ID (EID)).
+ parameters:
+ - name: pelId
+ type: uint32
+ description: >
+ The PEL id to retrieve the BMC event log id.
+ returns:
+ - name: bmcLogId
+ type: uint32
+ description: >
+ The BMC event log id of the PEL.
+ errors:
+ - xyz.openbmc_project.Common.Error.InvalidArgument
enumerations:
- - name: RejectionReason
- description: >
- The reason the PEL was rejected
- values:
- - name: BadPEL
- description: >
- The PEL was malformed.
- - name: HostFull
- description: >
- The host does not have room for more PELs at this time.
-
+ - name: RejectionReason
+ description: >
+ The reason the PEL was rejected
+ values:
+ - name: BadPEL
+ description: >
+ The PEL was malformed.
+ - name: HostFull
+ description: >
+ The host does not have room for more PELs at this time.
diff --git a/yaml/org/open_power/Logging/PEL/Entry.interface.yaml b/yaml/org/open_power/Logging/PEL/Entry.interface.yaml
index 8a91d10..8576943 100644
--- a/yaml/org/open_power/Logging/PEL/Entry.interface.yaml
+++ b/yaml/org/open_power/Logging/PEL/Entry.interface.yaml
@@ -5,23 +5,23 @@
type: boolean
default: false
description: >
- Hidden Error - This flag allows events to be placed in a system, but
- remain hidden from the customer. This event log is visible to
- development personnel only, e.g. hardware recovered error, etc. No
- service action is required for this type of errors. In general, when
- this value is used, the Error Action Flags has the value of
- "Hidden Error". An event log with this value is used primarily for
- error thresholding design/code debug or as a record to indicate an
- error frequency or trend.
+ Hidden Error - This flag allows events to be placed in a system, but
+ remain hidden from the customer. This event log is visible to
+ development personnel only, e.g. hardware recovered error, etc. No
+ service action is required for this type of errors. In general, when
+ this value is used, the Error Action Flags has the value of
+ "Hidden Error". An event log with this value is used primarily for
+ error thresholding design/code debug or as a record to indicate an
+ error frequency or trend.
- name: Subsystem
type: string
description: >
- A free form, implementation defined string which uniquely and
- permanently identifies a specific subsystem string. This field should
- not be used for programmatic interrogation of an object.
+ A free form, implementation defined string which uniquely and
+ permanently identifies a specific subsystem string. This field should
+ not be used for programmatic interrogation of an object.
- name: ManagementSystemAck
type: boolean
default: false
description: >
- Notifies the PEL handler that the management system acknowledged a PEL.
- The management system can be any system monitoring the hardware.
\ No newline at end of file
+ Notifies the PEL handler that the management system acknowledged a PEL.
+ The management system can be any system monitoring the hardware.
diff --git a/yaml/org/open_power/OCC/PassThrough.interface.yaml b/yaml/org/open_power/OCC/PassThrough.interface.yaml
index 99ed8a2..1a4ef66 100644
--- a/yaml/org/open_power/OCC/PassThrough.interface.yaml
+++ b/yaml/org/open_power/OCC/PassThrough.interface.yaml
@@ -5,41 +5,40 @@
description: >
Pass through a command to the OCC.
parameters:
- - name: command
- # TODO via https://github.com/openbmc/openbmc/issues/1160. This should
- # change to array[byte]. As of now, the REST server maps any numeric
- # data to int32.
- type: array[int32]
- description: >
- An array of integers representing the command and payload. This
- should still be bytes worth of data (as though using array[byte]),
- so each entry in the array should pack as many bytes as possible.
+ - name: command
+ # TODO via https://github.com/openbmc/openbmc/issues/1160. This should
+ # change to array[byte]. As of now, the REST server maps any numeric
+ # data to int32.
+ type: array[int32]
+ description: >
+ An array of integers representing the command and payload. This
+ should still be bytes worth of data (as though using array[byte]),
+ so each entry in the array should pack as many bytes as possible.
returns:
- - name: response
- # TODO via https://github.com/openbmc/openbmc/issues/1160. This should
- # change to array[byte]. As of now, the REST server maps any numeric
- # data to int32.
- type: array[int32]
- description: >
- An array of integers representing the response. This
- should still be bytes worth of data (as though using array[byte]),
- so each entry in the array should pack as many bytes as possible.
+ - name: response
+ # TODO via https://github.com/openbmc/openbmc/issues/1160. This should
+ # change to array[byte]. As of now, the REST server maps any numeric
+ # data to int32.
+ type: array[int32]
+ description: >
+ An array of integers representing the response. This
+ should still be bytes worth of data (as though using array[byte]),
+ so each entry in the array should pack as many bytes as possible.
- name: SetMode
description: >
Change the power mode of the system.
parameters:
- - name: mode
- type: byte
- description: >
- Desired power mode of the system.
- - name: frequencyPoint
- type: uint16
- description: >
- Frequency point required by some power modes.
+ - name: mode
+ type: byte
+ description: >
+ Desired power mode of the system.
+ - name: frequencyPoint
+ type: uint16
+ description: >
+ Frequency point required by some power modes.
returns:
- - name: status
- type: boolean
- description: >
- Returns true if the mode change was accepted.
-
+ - name: status
+ type: boolean
+ description: >
+ Returns true if the mode change was accepted.
diff --git a/yaml/org/open_power/OCC/Status.interface.yaml b/yaml/org/open_power/OCC/Status.interface.yaml
index ea99fa4..b913c4f 100644
--- a/yaml/org/open_power/OCC/Status.interface.yaml
+++ b/yaml/org/open_power/OCC/Status.interface.yaml
@@ -5,19 +5,19 @@
- name: OccActive
type: boolean
description: >
- Indicates whether OCC is active or not
+ Indicates whether OCC is active or not
- name: ThrottleProcTemp
type: boolean
default: 0
description: >
- Indicates processor throttling due to an over temperature condition
+ Indicates processor throttling due to an over temperature condition
- name: ThrottleProcPower
type: boolean
default: 0
description: >
- Indicates processor throttling due to reaching the power cap limit
+ Indicates processor throttling due to reaching the power cap limit
- name: ThrottleMemTemp
type: boolean
default: 0
description: >
- Indicates memory throttling due to an over temperature condition
+ Indicates memory throttling due to an over temperature condition
diff --git a/yaml/org/open_power/Sensor/Aggregation/History/Average.interface.yaml b/yaml/org/open_power/Sensor/Aggregation/History/Average.interface.yaml
index 93795d9..ae2c326 100644
--- a/yaml/org/open_power/Sensor/Aggregation/History/Average.interface.yaml
+++ b/yaml/org/open_power/Sensor/Aggregation/History/Average.interface.yaml
@@ -32,26 +32,26 @@
enumerations:
- name: Unit
description: >
- A sensor reading unit.
+ A sensor reading unit.
values:
- - name: DegreesC
- description: >
- Temperature as degrees Celsius.
- - name: RPMS
- description: >
- Frequency of rotation as revolutions per minute.
- - name: Volts
- description: >
- Electromotive force as volts.
- - name: Meters
- description: >
- Length as meters.
- - name: Amperes
- description: >
- Electrical charge flow rate as Amperes.
- - name: Watts
- description: >
- Rate of energy transfer as Watts.
- - name: Joules
- description: >
- Energy transfer as Joules.
+ - name: DegreesC
+ description: >
+ Temperature as degrees Celsius.
+ - name: RPMS
+ description: >
+ Frequency of rotation as revolutions per minute.
+ - name: Volts
+ description: >
+ Electromotive force as volts.
+ - name: Meters
+ description: >
+ Length as meters.
+ - name: Amperes
+ description: >
+ Electrical charge flow rate as Amperes.
+ - name: Watts
+ description: >
+ Rate of energy transfer as Watts.
+ - name: Joules
+ description: >
+ Energy transfer as Joules.
diff --git a/yaml/org/open_power/Sensor/Aggregation/History/Maximum.interface.yaml b/yaml/org/open_power/Sensor/Aggregation/History/Maximum.interface.yaml
index e0f116a..9143ce4 100644
--- a/yaml/org/open_power/Sensor/Aggregation/History/Maximum.interface.yaml
+++ b/yaml/org/open_power/Sensor/Aggregation/History/Maximum.interface.yaml
@@ -32,26 +32,26 @@
enumerations:
- name: Unit
description: >
- A sensor reading unit.
+ A sensor reading unit.
values:
- - name: DegreesC
- description: >
- Temperature as degrees Celsius.
- - name: RPMS
- description: >
- Frequency of rotation as revolutions per minute.
- - name: Volts
- description: >
- Electromotive force as volts.
- - name: Meters
- description: >
- Length as meters.
- - name: Amperes
- description: >
- Electrical charge flow rate as Amperes.
- - name: Watts
- description: >
- Rate of energy transfer as Watts.
- - name: Joules
- description: >
- Energy transfer as Joules.
+ - name: DegreesC
+ description: >
+ Temperature as degrees Celsius.
+ - name: RPMS
+ description: >
+ Frequency of rotation as revolutions per minute.
+ - name: Volts
+ description: >
+ Electromotive force as volts.
+ - name: Meters
+ description: >
+ Length as meters.
+ - name: Amperes
+ description: >
+ Electrical charge flow rate as Amperes.
+ - name: Watts
+ description: >
+ Rate of energy transfer as Watts.
+ - name: Joules
+ description: >
+ Energy transfer as Joules.
diff --git a/yaml/xyz/openbmc_project/BIOSConfig/Manager.interface.yaml b/yaml/xyz/openbmc_project/BIOSConfig/Manager.interface.yaml
index 98daf3a..7a1903b 100644
--- a/yaml/xyz/openbmc_project/BIOSConfig/Manager.interface.yaml
+++ b/yaml/xyz/openbmc_project/BIOSConfig/Manager.interface.yaml
@@ -10,50 +10,49 @@
To set the new value on existing attribute name.
It will create or add the pending attributes.
parameters:
- - name: AttributeName
- type: string
- description: >
- AttributeName which has to be changed.
- - name: AttributeValue
- type: variant[int64,string]
- description: >
- New attribute value
+ - name: AttributeName
+ type: string
+ description: >
+ AttributeName which has to be changed.
+ - name: AttributeValue
+ type: variant[int64,string]
+ description: >
+ New attribute value
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeReadOnly
- - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeNotFound
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeReadOnly
+ - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeNotFound
- name: GetAttribute
description: >
To get the attribute value of existing attributes.
parameters:
- - name: AttributeName
- type: string
- description: >
- To get the bios attribute current values and
- pending values if previously set by setAttribute or
- SetPendingAttributes.
+ - name: AttributeName
+ type: string
+ description: >
+ To get the bios attribute current values and
+ pending values if previously set by setAttribute or
+ SetPendingAttributes.
returns:
- - name: AttributeValueType
- type: enum[self.AttributeType]
- description: >
- PLDM attribute Type present in PLDM spec
- - name: CurrentValue
- type: variant[int64,string]
- description: >
- The attribute current value.
- - name: PendingValue
- type: variant[int64,string]
- description: >
- The pending attribute value if its available.
+ - name: AttributeValueType
+ type: enum[self.AttributeType]
+ description: >
+ PLDM attribute Type present in PLDM spec
+ - name: CurrentValue
+ type: variant[int64,string]
+ description: >
+ The attribute current value.
+ - name: PendingValue
+ type: variant[int64,string]
+ description: >
+ The pending attribute value if its available.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeNotFound
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeNotFound
properties:
-
- name: ResetBIOSSettings
type: enum[self.ResetFlag]
default: NoAction
@@ -65,110 +64,108 @@
- name: BaseBIOSTable
type: dict[string,struct[enum[self.AttributeType],boolean,string,string,string,variant[int64,string],variant[int64,string],array[struct[enum[self.BoundType], variant[int64, string]]]]]
description: >
- map{attributeName,struct{attributeType,readonlyStatus,displayname,
- description,menuPath,current,default,
- array{struct{optionstring,optionvalue}}}}
- Example 1:
- {"DdrFreqLimit",
- {xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String,
- false,
- "Memory Operating Speed Selection",
- "Force specific Memory Operating Speed or use Auto setting.",
- "Advanced/Memory Configuration/Memory Operating Speed Selection",
- "0x00",
- "0x0B",
- { {"OneOf", "auto"},
- {"OneOf", "2133"},
- {"OneOf", "2400"},
- {"OneOf", "2664"},
- {"OneOf", "2933"}
- }
- }
- }
- Example 2:
- {"BIOSSerialDebugLevel",
- {xyz.openbmc_project.BIOSConfig.Manager.AttributeType.Integer,
- false,
- "BIOS Serial Debug level",
- "BIOS Serial Debug level during system boot.",
- "Advanced/Debug Feature Selection",
- 0x00,
- 0x01,
- { {"MinBound", 0},
- {"MaxBound", 4},
- {"ScalarIncrement",1}
- }
- }
- }
-
+ map{attributeName,struct{attributeType,readonlyStatus,displayname,
+ description,menuPath,current,default,
+ array{struct{optionstring,optionvalue}}}}
+ Example 1:
+ {"DdrFreqLimit",
+ {xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String,
+ false,
+ "Memory Operating Speed Selection",
+ "Force specific Memory Operating Speed or use Auto setting.",
+ "Advanced/Memory Configuration/Memory Operating Speed Selection",
+ "0x00",
+ "0x0B",
+ { {"OneOf", "auto"},
+ {"OneOf", "2133"},
+ {"OneOf", "2400"},
+ {"OneOf", "2664"},
+ {"OneOf", "2933"}
+ }
+ }
+ }
+ Example 2:
+ {"BIOSSerialDebugLevel",
+ {xyz.openbmc_project.BIOSConfig.Manager.AttributeType.Integer,
+ false,
+ "BIOS Serial Debug level",
+ "BIOS Serial Debug level during system boot.",
+ "Advanced/Debug Feature Selection",
+ 0x00,
+ 0x01,
+ { {"MinBound", 0},
+ {"MaxBound", 4},
+ {"ScalarIncrement",1}
+ }
+ }
+ }
- name: PendingAttributes
type: dict[string,struct[enum[self.AttributeType],variant[int64,string]]]
description: >
- The Pending attribute name and new value.
- ex- { {"QuietBoot",Type.Integer, 0x1},
- { "DdrFreqLimit",Type.String,"2933"}
- }
+ The Pending attribute name and new value.
+ ex- { {"QuietBoot",Type.Integer, 0x1},
+ { "DdrFreqLimit",Type.String,"2933"}
+ }
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeNotFound
- - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeReadOnly
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeNotFound
+ - xyz.openbmc_project.BIOSConfig.Common.Error.AttributeReadOnly
enumerations:
- name: AttributeType
description: >
- Attribute Type.
+ Attribute Type.
values:
- - name: Enumeration
- description: >
- Enumeration value Type.
- - name: String
- description: >
- string value Type.
- - name: Password
- description: >
- Encoded string value Type
- - name: Integer
- description: >
- Integer value Type.
- - name: Boolean
- description: >
- Boolean value Type
+ - name: Enumeration
+ description: >
+ Enumeration value Type.
+ - name: String
+ description: >
+ string value Type.
+ - name: Password
+ description: >
+ Encoded string value Type
+ - name: Integer
+ description: >
+ Integer value Type.
+ - name: Boolean
+ description: >
+ Boolean value Type
- name: ResetFlag
description: >
- Reset BIOS setting type requested by user.
+ Reset BIOS setting type requested by user.
values:
- - name: NoAction
- description: >
- Default value, In order to cancel the reset BIOS settings.
- - name: FactoryDefaults
- description: >
- Used to set factory default settings.
- - name: FailSafeDefaults
- description: >
- Used to set the fail safe settings.
+ - name: NoAction
+ description: >
+ Default value, In order to cancel the reset BIOS settings.
+ - name: FactoryDefaults
+ description: >
+ Used to set factory default settings.
+ - name: FailSafeDefaults
+ description: >
+ Used to set the fail safe settings.
- name: BoundType
description: >
- Contain BoundType value for string and integer
+ Contain BoundType value for string and integer
values:
- - name: LowerBound
- description: >
- Used to define the lower bound value.
- - name: UpperBound
- description: >
- Used to define the upper bound value.
- - name: ScalarIncrement
- description: >
- Used to define scalar value of integer.
- - name: MinStringLength
- description: >
- Used to define minimum string length.
- - name: MaxStringLength
- description: >
- Used to define maximum string length.
- - name: OneOf
- description: >
- Used to define the enumeration options.
-
+ - name: LowerBound
+ description: >
+ Used to define the lower bound value.
+ - name: UpperBound
+ description: >
+ Used to define the upper bound value.
+ - name: ScalarIncrement
+ description: >
+ Used to define scalar value of integer.
+ - name: MinStringLength
+ description: >
+ Used to define minimum string length.
+ - name: MaxStringLength
+ description: >
+ Used to define maximum string length.
+ - name: OneOf
+ description: >
+ Used to define the enumeration options.
diff --git a/yaml/xyz/openbmc_project/BIOSConfig/Password.interface.yaml b/yaml/xyz/openbmc_project/BIOSConfig/Password.interface.yaml
index 913201f..2f20786 100644
--- a/yaml/xyz/openbmc_project/BIOSConfig/Password.interface.yaml
+++ b/yaml/xyz/openbmc_project/BIOSConfig/Password.interface.yaml
@@ -8,27 +8,25 @@
description: >
Change the BIOS setup password.
parameters:
- - name: UserName
- type: string
- description: >
- User name - user / admin.
- - name: CurrentPassword
- type: string
- description: >
- Current user/ admin Password.
- - name: NewPassword
- type: string
- description: >
- New user/ admin Password.
+ - name: UserName
+ type: string
+ description: >
+ User name - user / admin.
+ - name: CurrentPassword
+ type: string
+ description: >
+ Current user/ admin Password.
+ - name: NewPassword
+ type: string
+ description: >
+ New user/ admin Password.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.BIOSConfig.Common.Error.PasswordNotSettable
- - xyz.openbmc_project.BIOSConfig.Common.Error.InvalidCurrentPassword
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.BIOSConfig.Common.Error.PasswordNotSettable
+ - xyz.openbmc_project.BIOSConfig.Common.Error.InvalidCurrentPassword
properties:
-
- - name: PasswordInitialized
- type: boolean
- description: >
- To indicate BIOS password related details are recevied or not.
-
+ - name: PasswordInitialized
+ type: boolean
+ description: >
+ To indicate BIOS password related details are recevied or not.
diff --git a/yaml/xyz/openbmc_project/Certs.errors.yaml b/yaml/xyz/openbmc_project/Certs.errors.yaml
index 323eb8c..30cf837 100644
--- a/yaml/xyz/openbmc_project/Certs.errors.yaml
+++ b/yaml/xyz/openbmc_project/Certs.errors.yaml
@@ -1,3 +1,3 @@
# xyz.openbmc_project.Certs.Error.InvalidCertificate
- - name: InvalidCertificate
- description: Invalid certificate file.
+- name: InvalidCertificate
+ description: Invalid certificate file.
diff --git a/yaml/xyz/openbmc_project/Certs/Authority.interface.yaml b/yaml/xyz/openbmc_project/Certs/Authority.interface.yaml
index 4a9beea..98c940c 100644
--- a/yaml/xyz/openbmc_project/Certs/Authority.interface.yaml
+++ b/yaml/xyz/openbmc_project/Certs/Authority.interface.yaml
@@ -6,17 +6,17 @@
This method provides signing authority functionality.
parameters:
- - name: CSR
- type: string
- description: >
- Should be a valid PEM encoded Certificate signing request string.
+ - name: CSR
+ type: string
+ description: >
+ Should be a valid PEM encoded Certificate signing request string.
returns:
- - name: path
- type: path
- description: >
- The object path of an object that implements, at a minimum,
- xyz.openbmc_project.Certs.Entry and xyz.openbmc_project.Object.Delete
+ - name: path
+ type: path
+ description: >
+ The object path of an object that implements, at a minimum,
+ xyz.openbmc_project.Certs.Entry and xyz.openbmc_project.Object.Delete
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InvalidArgument
diff --git a/yaml/xyz/openbmc_project/Certs/CSR.interface.yaml b/yaml/xyz/openbmc_project/Certs/CSR.interface.yaml
index 82f8dd3..0741de7 100644
--- a/yaml/xyz/openbmc_project/Certs/CSR.interface.yaml
+++ b/yaml/xyz/openbmc_project/Certs/CSR.interface.yaml
@@ -10,9 +10,9 @@
xyz.openbmc_project.Object.Delete to allow the deletion of CSR objects.
returns:
- - name: CSRString
- type: string
- description: >
- CSR string in the Base-64 encoded PEM format.
+ - name: CSRString
+ type: string
+ description: >
+ CSR string in the Base-64 encoded PEM format.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/Certs/CSR/Create.interface.yaml b/yaml/xyz/openbmc_project/Certs/CSR/Create.interface.yaml
index 48b1bd1..824c6cc 100644
--- a/yaml/xyz/openbmc_project/Certs/CSR/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/Certs/CSR/Create.interface.yaml
@@ -20,140 +20,140 @@
and zero for integers.
parameters:
- - name: AlternativeNames
- type: array[string]
- description: >
- Additional hostnames of the component that is being secured.
- - name: ChallengePassword
- type: string
- description: >
- The challenge password to be applied to the certificate for
- revocation requests.
- - name: City
- type: string
- description: >
- The city or locality of the organization making the request.
- For Example Austin
- This is a required parameter.
- - name: CommonName
- type: string
- description: >
- The fully qualified domain name of the component that is being
- secured.
- This is a required parameter.
- - name: ContactPerson
- type: string
- description: >
- The name of the user making the request.
- - name: Country
- type: string
- description: >
- The country of the organization making the request.
- This is a required parameter.
- - name: Email
- type: string
- description: >
- The email address of the contact within the organization
- making the request.
- - name: GivenName
- type: string
- description: >
- The given name of the user making the request.
- - name: Initials
- type: string
- description: >
- The initials of the user making the request.
- - name: KeyBitLength
- type: int64
- description: >
- The length of the key in bits, if needed based on the value
- of the KeyPairAlgorithm parameter.
+ - name: AlternativeNames
+ type: array[string]
+ description: >
+ Additional hostnames of the component that is being secured.
+ - name: ChallengePassword
+ type: string
+ description: >
+ The challenge password to be applied to the certificate for
+ revocation requests.
+ - name: City
+ type: string
+ description: >
+ The city or locality of the organization making the request.
+ For Example Austin
+ This is a required parameter.
+ - name: CommonName
+ type: string
+ description: >
+ The fully qualified domain name of the component that is being
+ secured.
+ This is a required parameter.
+ - name: ContactPerson
+ type: string
+ description: >
+ The name of the user making the request.
+ - name: Country
+ type: string
+ description: >
+ The country of the organization making the request.
+ This is a required parameter.
+ - name: Email
+ type: string
+ description: >
+ The email address of the contact within the organization
+ making the request.
+ - name: GivenName
+ type: string
+ description: >
+ The given name of the user making the request.
+ - name: Initials
+ type: string
+ description: >
+ The initials of the user making the request.
+ - name: KeyBitLength
+ type: int64
+ description: >
+ The length of the key in bits, if needed based on the value
+ of the KeyPairAlgorithm parameter.
- Refer https://www.openssl.org/docs/man1.0.2/man1/genpkey.html
- - name: KeyCurveId
- type: string
- description: >
- The curve ID to be used with the key, if needed based on the
- value of the KeyPairAlgorithm parameter.
+ Refer https://www.openssl.org/docs/man1.0.2/man1/genpkey.html
+ - name: KeyCurveId
+ type: string
+ description: >
+ The curve ID to be used with the key, if needed based on the
+ value of the KeyPairAlgorithm parameter.
- Refer https://www.openssl.org/docs/man1.0.2/man1/genpkey.html
- - name: KeyPairAlgorithm
- type: string
- description: >
- The type of key pair for use with signing algorithms.
+ Refer https://www.openssl.org/docs/man1.0.2/man1/genpkey.html
+ - name: KeyPairAlgorithm
+ type: string
+ description: >
+ The type of key pair for use with signing algorithms.
- Valid built-in algorithm names for private key generation are
- RSA and EC.
- - name: KeyUsage
- type: array[string]
- description: >
- Key usage extensions define the purpose of the public key contained
- in a certificate.
+ Valid built-in algorithm names for private key generation are
+ RSA and EC.
+ - name: KeyUsage
+ type: array[string]
+ description: >
+ Key usage extensions define the purpose of the public key contained
+ in a certificate.
- Valid Key usage extensions and its usage description.
+ Valid Key usage extensions and its usage description.
- ClientAuthentication: The public key is used for TLS WWW client
- authentication.
- CodeSigning: The public key is used for the signing of executable code.
- CRLSigning: The public key is used for verifying signatures on
- certificate revocation lists (CLRs).
- DataEncipherment: The public key is used for directly enciphering
- raw user data without the use of an intermediate
- symmetric cipher.
- DecipherOnly: The public key could be used for deciphering data
- while performing key agreement.
- DigitalSignature: The public key is used for verifying digital
- signatures, other than signatures on certificates
- and CRLs.
- EmailProtection: The public key is used for email protection.
- EncipherOnly: The public key could be used for enciphering data
- while performing key agreement.
- KeyCertSign: The public key is used for verifying signatures on
- public key certificates.
- KeyEncipherment: The public key is used for enciphering private or
- secret keys.
- NonRepudiation: The public key is used to verify digital signatures,
- other than signatures on certificates and CRLs,
- and used to provide a non- repudiation service that
- protects against the signing entity falsely denying
- some action.
- OCSPSigning: The public key is used for signing OCSP responses.
- ServerAuthentication: The public key is used for TLS WWW server
- authentication.
- Timestamping: The public key is used for binding the hash of an
- object to a time.
- - name: Organization
- type: string
- description: >
- The legal name of the organization. This should not be abbreviated
- and should include suffixes such as Inc, Corp, or LLC.
- For example, IBM Corp.
- This is a required parameter.
- - name: OrganizationalUnit
- type: string
- description: >
- The name of the unit or division of the organization making the
- request.
- This is a required parameter.
- - name: State
- type: string
- description: >
- The state or province where the organization is located.
- This should not be abbreviated. For example, Texas.
- This is a required parameter.
- - name: Surname
- type: string
- description: >
- The surname of the user making the request.
- - name: UnstructuredName
- type: string
- description: >
- The unstructured name of the subject.
+ ClientAuthentication: The public key is used for TLS WWW client
+ authentication.
+ CodeSigning: The public key is used for the signing of executable code.
+ CRLSigning: The public key is used for verifying signatures on
+ certificate revocation lists (CLRs).
+ DataEncipherment: The public key is used for directly enciphering
+ raw user data without the use of an intermediate
+ symmetric cipher.
+ DecipherOnly: The public key could be used for deciphering data
+ while performing key agreement.
+ DigitalSignature: The public key is used for verifying digital
+ signatures, other than signatures on certificates
+ and CRLs.
+ EmailProtection: The public key is used for email protection.
+ EncipherOnly: The public key could be used for enciphering data
+ while performing key agreement.
+ KeyCertSign: The public key is used for verifying signatures on
+ public key certificates.
+ KeyEncipherment: The public key is used for enciphering private or
+ secret keys.
+ NonRepudiation: The public key is used to verify digital signatures,
+ other than signatures on certificates and CRLs,
+ and used to provide a non- repudiation service that
+ protects against the signing entity falsely denying
+ some action.
+ OCSPSigning: The public key is used for signing OCSP responses.
+ ServerAuthentication: The public key is used for TLS WWW server
+ authentication.
+ Timestamping: The public key is used for binding the hash of an
+ object to a time.
+ - name: Organization
+ type: string
+ description: >
+ The legal name of the organization. This should not be abbreviated
+ and should include suffixes such as Inc, Corp, or LLC.
+ For example, IBM Corp.
+ This is a required parameter.
+ - name: OrganizationalUnit
+ type: string
+ description: >
+ The name of the unit or division of the organization making the
+ request.
+ This is a required parameter.
+ - name: State
+ type: string
+ description: >
+ The state or province where the organization is located.
+ This should not be abbreviated. For example, Texas.
+ This is a required parameter.
+ - name: Surname
+ type: string
+ description: >
+ The surname of the user making the request.
+ - name: UnstructuredName
+ type: string
+ description: >
+ The unstructured name of the subject.
returns:
- - name: path
- type: string
- description: >
- The object path of the D-Bus object to be watch for retrieving
- the CSR string.
+ - name: path
+ type: string
+ description: >
+ The object path of the D-Bus object to be watch for retrieving
+ the CSR string.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/Certs/Entry.interface.yaml b/yaml/xyz/openbmc_project/Certs/Entry.interface.yaml
index d4c46ce..4547798 100644
--- a/yaml/xyz/openbmc_project/Certs/Entry.interface.yaml
+++ b/yaml/xyz/openbmc_project/Certs/Entry.interface.yaml
@@ -16,16 +16,16 @@
The current status of the signing operation.
enumerations:
- - name: State
- description: >
- Signing operation state enum.
- values:
- - name: Pending
- description: >
- Signing request is pending.
- - name: BadCSR
- description: >
- The CSR was malformed.
- - name: Complete
- description: >
- CSR signing complete
+ - name: State
+ description: >
+ Signing operation state enum.
+ values:
+ - name: Pending
+ description: >
+ Signing request is pending.
+ - name: BadCSR
+ description: >
+ The CSR was malformed.
+ - name: Complete
+ description: >
+ CSR signing complete
diff --git a/yaml/xyz/openbmc_project/Certs/Install.interface.yaml b/yaml/xyz/openbmc_project/Certs/Install.interface.yaml
index dbbfcd8..209b0cd 100644
--- a/yaml/xyz/openbmc_project/Certs/Install.interface.yaml
+++ b/yaml/xyz/openbmc_project/Certs/Install.interface.yaml
@@ -6,20 +6,20 @@
Install the certificate and restart the associated services.
NotAllowed error thrown if certificate already exists.
parameters:
- - name: Path
- type: string
- description: >
- Path of file that contains both the certificate public and
- private key. (Example: a .PEM file containing both signed
- certificate and private key).
+ - name: Path
+ type: string
+ description: >
+ Path of file that contains both the certificate public and
+ private key. (Example: a .PEM file containing both signed
+ certificate and private key).
returns:
- - name: ObjectPath
- type: string
- description: >
- D-Bus object path to created object.
+ - name: ObjectPath
+ type: string
+ description: >
+ D-Bus object path to created object.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.NotAllowed
- - xyz.openbmc_project.Certs.Error.InvalidCertificate
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Certs.Error.InvalidCertificate
diff --git a/yaml/xyz/openbmc_project/Certs/InstallAll.interface.yaml b/yaml/xyz/openbmc_project/Certs/InstallAll.interface.yaml
index 19d29f7..e375a07 100644
--- a/yaml/xyz/openbmc_project/Certs/InstallAll.interface.yaml
+++ b/yaml/xyz/openbmc_project/Certs/InstallAll.interface.yaml
@@ -5,18 +5,18 @@
description: >
Install the authority list and restart the associated services.
parameters:
- - name: Path
- type: string
- description: >
- Path of the file that contains a list of root certificates.
+ - name: Path
+ type: string
+ description: >
+ Path of the file that contains a list of root certificates.
returns:
- - name: ObjectPath
- type: array[object_path]
- description: >
- D-Bus object path to created objects.
+ - name: ObjectPath
+ type: array[object_path]
+ description: >
+ D-Bus object path to created objects.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.NotAllowed
- - xyz.openbmc_project.Certs.Error.InvalidCertificate
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Certs.Error.InvalidCertificate
diff --git a/yaml/xyz/openbmc_project/Certs/Replace.interface.yaml b/yaml/xyz/openbmc_project/Certs/Replace.interface.yaml
index 714c589..bf35d2f 100644
--- a/yaml/xyz/openbmc_project/Certs/Replace.interface.yaml
+++ b/yaml/xyz/openbmc_project/Certs/Replace.interface.yaml
@@ -5,13 +5,13 @@
description: >
Replace the certificate and restart the associated services.
parameters:
- - name: Path
- type: string
- description: >
- Path of file that contains both the certificate public and
- private key. (Example: a .PEM file containing both signed
- certificate and private key).
+ - name: Path
+ type: string
+ description: >
+ Path of file that contains both the certificate public and
+ private key. (Example: a .PEM file containing both signed
+ certificate and private key).
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Certs.Error.InvalidCertificate
- - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Certs.Error.InvalidCertificate
+ - xyz.openbmc_project.Common.Error.NotAllowed
diff --git a/yaml/xyz/openbmc_project/Certs/ReplaceAll.interface.yaml b/yaml/xyz/openbmc_project/Certs/ReplaceAll.interface.yaml
index dbbfffe..cc188fb 100644
--- a/yaml/xyz/openbmc_project/Certs/ReplaceAll.interface.yaml
+++ b/yaml/xyz/openbmc_project/Certs/ReplaceAll.interface.yaml
@@ -6,16 +6,16 @@
Replace the current authorities list and restart the associated
services.
parameters:
- - name: Path
- type: string
- description: >
- Path of file that contains multiple root certificates.
+ - name: Path
+ type: string
+ description: >
+ Path of file that contains multiple root certificates.
returns:
- - name: ObjectPath
- type: array[object_path]
- description: >
- D-Bus object path to created objects.
+ - name: ObjectPath
+ type: array[object_path]
+ description: >
+ D-Bus object path to created objects.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Certs.Error.InvalidCertificate
- - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Certs.Error.InvalidCertificate
+ - xyz.openbmc_project.Common.Error.NotAllowed
diff --git a/yaml/xyz/openbmc_project/Channel/ChannelAccess.interface.yaml b/yaml/xyz/openbmc_project/Channel/ChannelAccess.interface.yaml
index 715fdec..03abc50 100644
--- a/yaml/xyz/openbmc_project/Channel/ChannelAccess.interface.yaml
+++ b/yaml/xyz/openbmc_project/Channel/ChannelAccess.interface.yaml
@@ -9,5 +9,5 @@
description: >
Maximum privilege associated with specific channel.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/Chassis/Buttons/HostSelector.interface.yaml b/yaml/xyz/openbmc_project/Chassis/Buttons/HostSelector.interface.yaml
index 397460e..378f5f4 100644
--- a/yaml/xyz/openbmc_project/Chassis/Buttons/HostSelector.interface.yaml
+++ b/yaml/xyz/openbmc_project/Chassis/Buttons/HostSelector.interface.yaml
@@ -10,13 +10,13 @@
type: size
default: 0
description: >
- The current position of the selector. Position 1 to N selects
- Host Instance t to N,Position 0 selects the BMC
- ( N is maximum number of hosts ).
+ The current position of the selector. Position 1 to N selects
+ Host Instance t to N,Position 0 selects the BMC
+ ( N is maximum number of hosts ).
- name: MaxPosition
type: size
default: 0
flags:
- readonly
description: >
- Maximum number for position value.
+ Maximum number for position value.
diff --git a/yaml/xyz/openbmc_project/Chassis/Buttons/ID.interface.yaml b/yaml/xyz/openbmc_project/Chassis/Buttons/ID.interface.yaml
index 0751ca4..5962652 100644
--- a/yaml/xyz/openbmc_project/Chassis/Buttons/ID.interface.yaml
+++ b/yaml/xyz/openbmc_project/Chassis/Buttons/ID.interface.yaml
@@ -6,15 +6,15 @@
methods:
- name: simPress
description: >
- Emulate ID button press.
+ Emulate ID button press.
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
signals:
- name: Released
description: >
- ID button released signal
+ ID button released signal
- name: Pressed
description: >
- ID button pressed signal
+ ID button pressed signal
diff --git a/yaml/xyz/openbmc_project/Chassis/Buttons/NMI.interface.yaml b/yaml/xyz/openbmc_project/Chassis/Buttons/NMI.interface.yaml
index bd4f5a3..ba36a69 100644
--- a/yaml/xyz/openbmc_project/Chassis/Buttons/NMI.interface.yaml
+++ b/yaml/xyz/openbmc_project/Chassis/Buttons/NMI.interface.yaml
@@ -7,27 +7,27 @@
methods:
- name: simPress
description: >
- Emulate NMI button press.
+ Emulate NMI button press.
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
properties:
- name: Enabled
type: boolean
default: true
description: >
- Enable/disable NMI button.
- false means NMI button is disabled
- true means NMI button is enabled
+ Enable/disable NMI button.
+ false means NMI button is disabled
+ true means NMI button is enabled
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
signals:
- name: Released
description: >
- NMI button released signal
+ NMI button released signal
- name: Pressed
description: >
- NMI button pressed signal
+ NMI button pressed signal
diff --git a/yaml/xyz/openbmc_project/Chassis/Buttons/Power.interface.yaml b/yaml/xyz/openbmc_project/Chassis/Buttons/Power.interface.yaml
index 466fc03..d594bd0 100644
--- a/yaml/xyz/openbmc_project/Chassis/Buttons/Power.interface.yaml
+++ b/yaml/xyz/openbmc_project/Chassis/Buttons/Power.interface.yaml
@@ -3,37 +3,37 @@
methods:
- name: simPress
description: >
- Emulate power button press.
+ Emulate power button press.
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
- name: simLongPress
description: >
- Emulate power button long press.
+ Emulate power button long press.
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
properties:
- name: Enabled
type: boolean
default: true
description: >
- Enable/disable power button.
- false means power button is disabled
- true means power button is enabled
+ Enable/disable power button.
+ false means power button is disabled
+ true means power button is enabled
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
signals:
- name: Released
description: >
- Power button released signal
+ Power button released signal
- name: Pressed
description: >
- Power button pressed signal
+ Power button pressed signal
- name: PressedLong
description: >
- Power button long pressed signal
+ Power button long pressed signal
diff --git a/yaml/xyz/openbmc_project/Chassis/Buttons/Reset.interface.yaml b/yaml/xyz/openbmc_project/Chassis/Buttons/Reset.interface.yaml
index 7db8bd5..f67ed71 100644
--- a/yaml/xyz/openbmc_project/Chassis/Buttons/Reset.interface.yaml
+++ b/yaml/xyz/openbmc_project/Chassis/Buttons/Reset.interface.yaml
@@ -3,27 +3,27 @@
methods:
- name: simPress
description: >
- Emulate reset button press.
+ Emulate reset button press.
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
properties:
- name: Enabled
type: boolean
default: true
description: >
- Enable/disable reset button.
- false means reset button is disabled
- true means reset button is enabled
+ Enable/disable reset button.
+ false means reset button is disabled
+ true means reset button is enabled
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
signals:
- name: Released
description: >
- Reset button released signal
+ Reset button released signal
- name: Pressed
description: >
- Reset button pressed signal
+ Reset button pressed signal
diff --git a/yaml/xyz/openbmc_project/Chassis/Control/NMISource.interface.yaml b/yaml/xyz/openbmc_project/Chassis/Control/NMISource.interface.yaml
index a04bd10..cb1d037 100644
--- a/yaml/xyz/openbmc_project/Chassis/Control/NMISource.interface.yaml
+++ b/yaml/xyz/openbmc_project/Chassis/Control/NMISource.interface.yaml
@@ -5,42 +5,42 @@
description: >
Enables the BMC NMI out event.
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
properties:
- name: BMCSource
type: enum[self.BMCSourceSignal]
description: >
Keeps track of NMI signal source in BMC.
- default: 'None'
+ default: "None"
enumerations:
- - name: BMCSourceSignal
- description: >
- The type of NMI source.
- values:
- - name: None
- description: >
- NONE NMI signal.
- - name: FrontPanelButton
- description: >
- Via Front Panel NMI button.
- - name: Watchdog
- description: >
- Via watchdog pre-timeout.
- - name: ChassisCmd
- description: >
- Via Chassis command.
- - name: MemoryError
- description: >
- Via memory error.
- - name: PciBusError
- description: >
- Via PCI bus error(PERR & SERR).
- - name: PCH
- description: >
- Via southbridge NMI.
- - name: Chipset
- description: >
- Via chipset NMI.
+ - name: BMCSourceSignal
+ description: >
+ The type of NMI source.
+ values:
+ - name: None
+ description: >
+ NONE NMI signal.
+ - name: FrontPanelButton
+ description: >
+ Via Front Panel NMI button.
+ - name: Watchdog
+ description: >
+ Via watchdog pre-timeout.
+ - name: ChassisCmd
+ description: >
+ Via Chassis command.
+ - name: MemoryError
+ description: >
+ Via memory error.
+ - name: PciBusError
+ description: >
+ Via PCI bus error(PERR & SERR).
+ - name: PCH
+ description: >
+ Via southbridge NMI.
+ - name: Chipset
+ description: >
+ Via chipset NMI.
diff --git a/yaml/xyz/openbmc_project/Chassis/Control/Power.interface.yaml b/yaml/xyz/openbmc_project/Chassis/Control/Power.interface.yaml
index 082586f..702152e 100644
--- a/yaml/xyz/openbmc_project/Chassis/Control/Power.interface.yaml
+++ b/yaml/xyz/openbmc_project/Chassis/Control/Power.interface.yaml
@@ -3,29 +3,29 @@
methods:
- name: forcePowerOff
description: >
- Force power off the host.
+ Force power off the host.
returns:
- - name: status
- type: boolean
- description: >
- The result of power off command.
+ - name: status
+ type: boolean
+ description: >
+ The result of power off command.
errors:
- - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
- - xyz.openbmc_project.Chassis.Common.Error.IOError
+ - xyz.openbmc_project.Chassis.Common.Error.UnsupportedCommand
+ - xyz.openbmc_project.Chassis.Common.Error.IOError
properties:
- name: PGood
type: boolean
default: false
description: >
- PSU Power good property
- It is a read-only property.
+ PSU Power good property
+ It is a read-only property.
- name: State
type: int32
default: 0
description: >
- System power status
- 0: power is off
- 1: power is on
- Setting its value to change the system state
- Read its value to get the system state.
\ No newline at end of file
+ System power status
+ 0: power is off
+ 1: power is on
+ Setting its value to change the system state
+ Read its value to get the system state.
diff --git a/yaml/xyz/openbmc_project/Chassis/Intrusion.interface.yaml b/yaml/xyz/openbmc_project/Chassis/Intrusion.interface.yaml
index b3fba48..2f9f50f 100644
--- a/yaml/xyz/openbmc_project/Chassis/Intrusion.interface.yaml
+++ b/yaml/xyz/openbmc_project/Chassis/Intrusion.interface.yaml
@@ -5,6 +5,6 @@
- name: Status
type: string
description: >
- Status string of chassis intrusion detector.
- The value is defined in chassis redfish schema.
- Can be "Normal" or "HardwareIntrusion".
+ Status string of chassis intrusion detector.
+ The value is defined in chassis redfish schema.
+ Can be "Normal" or "HardwareIntrusion".
diff --git a/yaml/xyz/openbmc_project/Collection/DeleteAll.interface.yaml b/yaml/xyz/openbmc_project/Collection/DeleteAll.interface.yaml
index 9bb7d35..e6c9a27 100755
--- a/yaml/xyz/openbmc_project/Collection/DeleteAll.interface.yaml
+++ b/yaml/xyz/openbmc_project/Collection/DeleteAll.interface.yaml
@@ -3,7 +3,7 @@
methods:
- name: DeleteAll
description: >
- Delete all objects in the collection.
+ Delete all objects in the collection.
errors:
- - xyz.openbmc_project.Common.Error.NotAllowed
- - xyz.openbmc_project.Common.Error.Unavailable
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.Unavailable
diff --git a/yaml/xyz/openbmc_project/Common/Callout.metadata.yaml b/yaml/xyz/openbmc_project/Common/Callout.metadata.yaml
index 95872c1..e2c503e 100644
--- a/yaml/xyz/openbmc_project/Common/Callout.metadata.yaml
+++ b/yaml/xyz/openbmc_project/Common/Callout.metadata.yaml
@@ -1,34 +1,34 @@
- name: Device
meta:
- - str: "CALLOUT_ERRNO=%d"
- type: int32
- - str: "CALLOUT_DEVICE_PATH=%s"
- type: string
- process: true
+ - str: "CALLOUT_ERRNO=%d"
+ type: int32
+ - str: "CALLOUT_DEVICE_PATH=%s"
+ type: string
+ process: true
- name: GPIO
meta:
- - str: "CALLOUT_GPIO_NUM=%u"
- type: uint32
+ - str: "CALLOUT_GPIO_NUM=%u"
+ type: uint32
inherits:
- xyz.openbmc_project.Common.Callout.Device
- name: IIC
meta:
- - str: "CALLOUT_IIC_BUS=%s"
- type: string
- - str: "CALLOUT_IIC_ADDR=0x%hx"
- type: uint16
+ - str: "CALLOUT_IIC_BUS=%s"
+ type: string
+ - str: "CALLOUT_IIC_ADDR=0x%hx"
+ type: uint16
inherits:
- xyz.openbmc_project.Common.Callout.Device
- name: Inventory
meta:
- - str: "CALLOUT_INVENTORY_PATH=%s"
- type: string
- process: true
+ - str: "CALLOUT_INVENTORY_PATH=%s"
+ type: string
+ process: true
- name: IPMISensor
meta:
- - str: "CALLOUT_IPMI_SENSOR_NUM=%u"
- type: uint32
+ - str: "CALLOUT_IPMI_SENSOR_NUM=%u"
+ type: uint32
diff --git a/yaml/xyz/openbmc_project/Common/FactoryReset.interface.yaml b/yaml/xyz/openbmc_project/Common/FactoryReset.interface.yaml
index 93943f9..42527f7 100644
--- a/yaml/xyz/openbmc_project/Common/FactoryReset.interface.yaml
+++ b/yaml/xyz/openbmc_project/Common/FactoryReset.interface.yaml
@@ -5,4 +5,4 @@
description: >
Generic method to start factory reset. Implemented by each service.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/Common/FilePath.interface.yaml b/yaml/xyz/openbmc_project/Common/FilePath.interface.yaml
index 355298a..2b332ae 100644
--- a/yaml/xyz/openbmc_project/Common/FilePath.interface.yaml
+++ b/yaml/xyz/openbmc_project/Common/FilePath.interface.yaml
@@ -8,4 +8,4 @@
- name: Path
type: string
description: >
- The filesystem path for the dbus object.
+ The filesystem path for the dbus object.
diff --git a/yaml/xyz/openbmc_project/Common/ObjectPath.interface.yaml b/yaml/xyz/openbmc_project/Common/ObjectPath.interface.yaml
index ad3a410..0c7a101 100644
--- a/yaml/xyz/openbmc_project/Common/ObjectPath.interface.yaml
+++ b/yaml/xyz/openbmc_project/Common/ObjectPath.interface.yaml
@@ -9,4 +9,4 @@
- name: Path
type: string
description: >
- The object path of a D-Bus object.
+ The object path of a D-Bus object.
diff --git a/yaml/xyz/openbmc_project/Common/Progress.interface.yaml b/yaml/xyz/openbmc_project/Common/Progress.interface.yaml
index 6c0dc44..139a1ff 100644
--- a/yaml/xyz/openbmc_project/Common/Progress.interface.yaml
+++ b/yaml/xyz/openbmc_project/Common/Progress.interface.yaml
@@ -28,17 +28,17 @@
enumerations:
- name: OperationStatus
description: >
- Status of the activity
+ Status of the activity
values:
- - name: InProgress
- description: >
- Requested operation is in progress.
- - name: Completed
- description: >
- The operation is completed.
- - name: Failed
- description: >
- The operation encountered a failure.
- - name: Aborted
- description: >
- The operation is aborted.
+ - name: InProgress
+ description: >
+ Requested operation is in progress.
+ - name: Completed
+ description: >
+ The operation is completed.
+ - name: Failed
+ description: >
+ The operation encountered a failure.
+ - name: Aborted
+ description: >
+ The operation is aborted.
diff --git a/yaml/xyz/openbmc_project/Common/TFTP.interface.yaml b/yaml/xyz/openbmc_project/Common/TFTP.interface.yaml
index 9a1b061..f14eaf2 100644
--- a/yaml/xyz/openbmc_project/Common/TFTP.interface.yaml
+++ b/yaml/xyz/openbmc_project/Common/TFTP.interface.yaml
@@ -5,14 +5,14 @@
description: >
Download a file via TFTP.
parameters:
- - name: FileName
- type: string
- description: >
- The name of the file to transfer.
- - name: ServerAddress
- type: string
- description: >
- The TFTP Server IP Address.
+ - name: FileName
+ type: string
+ description: >
+ The name of the file to transfer.
+ - name: ServerAddress
+ type: string
+ description: >
+ The TFTP Server IP Address.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
diff --git a/yaml/xyz/openbmc_project/Condition/HostFirmware.interface.yaml b/yaml/xyz/openbmc_project/Condition/HostFirmware.interface.yaml
index 3ee8190..acb44a3 100644
--- a/yaml/xyz/openbmc_project/Condition/HostFirmware.interface.yaml
+++ b/yaml/xyz/openbmc_project/Condition/HostFirmware.interface.yaml
@@ -7,21 +7,21 @@
properties:
- name: CurrentFirmwareCondition
type: enum[self.FirmwareCondition]
- default: 'Unknown'
+ default: "Unknown"
description: >
The current condition of the host
enumerations:
- name: FirmwareCondition
description: >
- The current condition of the host firmware
+ The current condition of the host firmware
values:
- - name: 'Unknown'
- description: >
- The condition of the host firmware is unknown
- - name: 'Off'
- description: >
- Host firmware is not responsive to communication
- - name: 'Running'
- description: >
- Host firmware is running and responsive to communication
+ - name: "Unknown"
+ description: >
+ The condition of the host firmware is unknown
+ - name: "Off"
+ description: >
+ Host firmware is not responsive to communication
+ - name: "Running"
+ description: >
+ Host firmware is running and responsive to communication
diff --git a/yaml/xyz/openbmc_project/Control/Boot/Mode.interface.yaml b/yaml/xyz/openbmc_project/Control/Boot/Mode.interface.yaml
index 879ff76..6d9608a 100644
--- a/yaml/xyz/openbmc_project/Control/Boot/Mode.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Boot/Mode.interface.yaml
@@ -11,14 +11,14 @@
enumerations:
- name: Modes
description: >
- Possible boot modes.
+ Possible boot modes.
values:
- - name: Regular
- description: >
- The regular/default mode, such as boot to an OS.
- - name: Safe
- description: >
- Boot to a diagnostic/trouble-shooting mode.
- - name: Setup
- description: >
- Boot to BIOS setup.
+ - name: Regular
+ description: >
+ The regular/default mode, such as boot to an OS.
+ - name: Safe
+ description: >
+ Boot to a diagnostic/trouble-shooting mode.
+ - name: Setup
+ description: >
+ Boot to BIOS setup.
diff --git a/yaml/xyz/openbmc_project/Control/Boot/RebootAttempts.interface.yaml b/yaml/xyz/openbmc_project/Control/Boot/RebootAttempts.interface.yaml
index a7f388d..ebadd6f 100644
--- a/yaml/xyz/openbmc_project/Control/Boot/RebootAttempts.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Boot/RebootAttempts.interface.yaml
@@ -5,4 +5,4 @@
- name: AttemptsLeft
type: uint32
description: >
- Current number of reboot attempts left.
+ Current number of reboot attempts left.
diff --git a/yaml/xyz/openbmc_project/Control/Boot/Source.interface.yaml b/yaml/xyz/openbmc_project/Control/Boot/Source.interface.yaml
index facf5d7..8a7b46b 100644
--- a/yaml/xyz/openbmc_project/Control/Boot/Source.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Boot/Source.interface.yaml
@@ -10,23 +10,23 @@
enumerations:
- name: Sources
description: >
- Possible sources of a boot image.
+ Possible sources of a boot image.
values:
- - name: Disk
- description: >
- Boot from the local hard disk.
- - name: ExternalMedia
- description: >
- Boot from CD/DVD.
- - name: Network
- description: >
- Boot from a remote source over a network.
- - name: Default
- description: >
- Boot from an implementation defined source.
- - name: RemovableMedia
- description: >
- Boot from floppy/primary removable media (USB).
- - name: HTTP
- description: >
- Boot from a remote source over http/https.
+ - name: Disk
+ description: >
+ Boot from the local hard disk.
+ - name: ExternalMedia
+ description: >
+ Boot from CD/DVD.
+ - name: Network
+ description: >
+ Boot from a remote source over a network.
+ - name: Default
+ description: >
+ Boot from an implementation defined source.
+ - name: RemovableMedia
+ description: >
+ Boot from floppy/primary removable media (USB).
+ - name: HTTP
+ description: >
+ Boot from a remote source over http/https.
diff --git a/yaml/xyz/openbmc_project/Control/Boot/Type.interface.yaml b/yaml/xyz/openbmc_project/Control/Boot/Type.interface.yaml
index 21063be..7a524fb 100644
--- a/yaml/xyz/openbmc_project/Control/Boot/Type.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Boot/Type.interface.yaml
@@ -11,11 +11,11 @@
enumerations:
- name: Types
description: >
- Possible types of a boot image.
+ Possible types of a boot image.
values:
- - name: Legacy
- description: >
- PC compatible boot.
- - name: EFI
- description: >
- Extensible Firmware Interface Boot.
+ - name: Legacy
+ description: >
+ PC compatible boot.
+ - name: EFI
+ description: >
+ Extensible Firmware Interface Boot.
diff --git a/yaml/xyz/openbmc_project/Control/FanRedundancy.interface.yaml b/yaml/xyz/openbmc_project/Control/FanRedundancy.interface.yaml
index 50ae5bc..17e956a 100644
--- a/yaml/xyz/openbmc_project/Control/FanRedundancy.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/FanRedundancy.interface.yaml
@@ -4,19 +4,19 @@
- name: AllowedFailures
type: byte
flags:
- - const
+ - const
description: >
Number of fans in error state before redundancy is lost.
- name: Collection
type: array[path]
flags:
- - const
+ - const
description: >
The group of fans tracked by this redundancy object.
- name: Status
type: enum[self.State]
flags:
- - const
+ - const
description: >
The current redundancy status.
@@ -25,13 +25,12 @@
description: >
Possible redundancy states.
values:
- - name: Full
- description: >
- System is in a fully redundant state.
- - name: Degraded
- description: >
- Redundancy is in a degraded state.
- - name: Failed
- description: >
- System has lost redundancy.
-
+ - name: Full
+ description: >
+ System is in a fully redundant state.
+ - name: Degraded
+ description: >
+ Redundancy is in a degraded state.
+ - name: Failed
+ description: >
+ System has lost redundancy.
diff --git a/yaml/xyz/openbmc_project/Control/FieldMode.interface.yaml b/yaml/xyz/openbmc_project/Control/FieldMode.interface.yaml
index 639fa43..5ccaeae 100644
--- a/yaml/xyz/openbmc_project/Control/FieldMode.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/FieldMode.interface.yaml
@@ -12,4 +12,4 @@
user attempts to set the property value to false.
default: false
errors:
- - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.NotAllowed
diff --git a/yaml/xyz/openbmc_project/Control/Host.errors.yaml b/yaml/xyz/openbmc_project/Control/Host.errors.yaml
index c4918a6..b331d2d 100644
--- a/yaml/xyz/openbmc_project/Control/Host.errors.yaml
+++ b/yaml/xyz/openbmc_project/Control/Host.errors.yaml
@@ -1,4 +1,3 @@
#xyz.openbmc_project.Control.Host.CommandNotSupported
- name: CommandNotSupported
description: Command is not supported
-
diff --git a/yaml/xyz/openbmc_project/Control/Host.interface.yaml b/yaml/xyz/openbmc_project/Control/Host.interface.yaml
index afe9bad..eec2ce0 100644
--- a/yaml/xyz/openbmc_project/Control/Host.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Host.interface.yaml
@@ -17,39 +17,39 @@
signals:
- name: CommandComplete
description: >
- Signal indicating that a Command has completed
+ Signal indicating that a Command has completed
properties:
- - name: command
- type: enum[self.Command]
- description: Executed command
- - name: result
- type: enum[self.Result]
- description: Result of the command execution
+ - name: command
+ type: enum[self.Command]
+ description: Executed command
+ - name: result
+ type: enum[self.Result]
+ description: Result of the command execution
enumerations:
- name: Command
description: >
- The command to execute against the host
+ The command to execute against the host
values:
- - name: SoftOff
- description: >
- Host firmware should do a clean shutdown and request a chassis power
- off to the BMC when complete. This command will return once the
- command has been sent to the host.
- - name: Heartbeat
- description: >
- Note: This is in the process of being deprecated in favor of the
- new xyz.openbmc_project.Condition.HostFirmware interface.
- Used to determine if the host is running and functional. This
- command will return once the command has been sent to the host.
- The response to the attention and the reading of the command
- provides the needed functional information.
+ - name: SoftOff
+ description: >
+ Host firmware should do a clean shutdown and request a chassis power
+ off to the BMC when complete. This command will return once the
+ command has been sent to the host.
+ - name: Heartbeat
+ description: >
+ Note: This is in the process of being deprecated in favor of the
+ new xyz.openbmc_project.Condition.HostFirmware interface.
+ Used to determine if the host is running and functional. This
+ command will return once the command has been sent to the host.
+ The response to the attention and the reading of the command
+ provides the needed functional information.
- name: Result
description: >
- The result of the command execution
+ The result of the command execution
values:
- - name: Success
- description: Command execution was a success
- - name: Failure
- description: Command execution was a failure
+ - name: Success
+ description: Command execution was a success
+ - name: Failure
+ description: Command execution was a failure
diff --git a/yaml/xyz/openbmc_project/Control/Host/NMI.interface.yaml b/yaml/xyz/openbmc_project/Control/Host/NMI.interface.yaml
index 71953b8..8b9c17a 100644
--- a/yaml/xyz/openbmc_project/Control/Host/NMI.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Host/NMI.interface.yaml
@@ -5,9 +5,7 @@
methods:
- name: NMI
description: >
- Generic method to initiate non maskable interrupt on all
- host processors.
+ Generic method to initiate non maskable interrupt on all
+ host processors.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
-
-
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/Control/Host/TurboAllowed.interface.yaml b/yaml/xyz/openbmc_project/Control/Host/TurboAllowed.interface.yaml
index af1f883..41b7394 100644
--- a/yaml/xyz/openbmc_project/Control/Host/TurboAllowed.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Host/TurboAllowed.interface.yaml
@@ -7,4 +7,4 @@
- name: TurboAllowed
type: boolean
description: >
- Set this to allow Turbo mode.
+ Set this to allow Turbo mode.
diff --git a/yaml/xyz/openbmc_project/Control/Power/ACPIPowerState.interface.yaml b/yaml/xyz/openbmc_project/Control/Power/ACPIPowerState.interface.yaml
index c8a3349..2f8dd84 100644
--- a/yaml/xyz/openbmc_project/Control/Power/ACPIPowerState.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Power/ACPIPowerState.interface.yaml
@@ -15,48 +15,48 @@
enumerations:
- name: ACPI
description: >
- Possible ACPI status.
+ Possible ACPI status.
values:
- - name: S0_G0_D0
- description: >
- Working, the system is running
- - name: S1_D1
- description: >
- Hardware context maintained, typically equates to proc/chip
- set clocks stopped.
- - name: S2_D2
- description: >
- Typically equates to stopped clocks with proc/cache context lost.
- - name: S3_D3
- description: >
- Typically equates to "suspend-to-RAM".
- - name: S4
- description: >
- Typically equates to "suspend-to-disk".
- - name: S5_G2
- description: >
- Soft off.
- - name: S4_S5
- description: >
- Sent when message source cannot differentiate between S4 and S5.
- - name: G3
- description: >
- Mechanical off.
- - name: SLEEP
- description: >
- Sleeping - cannot differentiate between S1-S3.
- - name: G1_SLEEP
- description: >
- Sleeping - cannot differentiate between S1-S4.
- - name: OVERRIDE
- description: >
- S5 entered by override.
- - name: LEGACY_ON
- description: >
- Legacy On - used when ACPI mode is disabled.
- - name: LEGACY_OFF
- description: >
- Legacy Off - used when ACPI mode is disabled.
- - name: Unknown
- description: >
- System power state has not been initialized.
+ - name: S0_G0_D0
+ description: >
+ Working, the system is running
+ - name: S1_D1
+ description: >
+ Hardware context maintained, typically equates to proc/chip
+ set clocks stopped.
+ - name: S2_D2
+ description: >
+ Typically equates to stopped clocks with proc/cache context lost.
+ - name: S3_D3
+ description: >
+ Typically equates to "suspend-to-RAM".
+ - name: S4
+ description: >
+ Typically equates to "suspend-to-disk".
+ - name: S5_G2
+ description: >
+ Soft off.
+ - name: S4_S5
+ description: >
+ Sent when message source cannot differentiate between S4 and S5.
+ - name: G3
+ description: >
+ Mechanical off.
+ - name: SLEEP
+ description: >
+ Sleeping - cannot differentiate between S1-S3.
+ - name: G1_SLEEP
+ description: >
+ Sleeping - cannot differentiate between S1-S4.
+ - name: OVERRIDE
+ description: >
+ S5 entered by override.
+ - name: LEGACY_ON
+ description: >
+ Legacy On - used when ACPI mode is disabled.
+ - name: LEGACY_OFF
+ description: >
+ Legacy Off - used when ACPI mode is disabled.
+ - name: Unknown
+ description: >
+ System power state has not been initialized.
diff --git a/yaml/xyz/openbmc_project/Control/Power/Cap.interface.yaml b/yaml/xyz/openbmc_project/Control/Power/Cap.interface.yaml
index 0f679ac..090b7d0 100644
--- a/yaml/xyz/openbmc_project/Control/Power/Cap.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Power/Cap.interface.yaml
@@ -40,4 +40,3 @@
the MinPowerCapValue. When the PowerCap is set to any value between
MinSoftPowerCapValue and MinPowerCapValue an attempt will be made to
maintain the cap but it will not be guaranted.
-
diff --git a/yaml/xyz/openbmc_project/Control/Power/Mode.interface.yaml b/yaml/xyz/openbmc_project/Control/Power/Mode.interface.yaml
index 0077d65..f3e835e 100644
--- a/yaml/xyz/openbmc_project/Control/Power/Mode.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Power/Mode.interface.yaml
@@ -12,23 +12,23 @@
enumerations:
- name: PowerMode
description: >
- Possible Power Mode settings
+ Possible Power Mode settings
values:
- - name: Static
- description: >
- This value shall indicate the system performs at a static base
- speed.
- - name: PowerSaving
- description: >
- This value shall indicate the system performs at reduced speeds
- to save power. This mode should be used when power saving is the
- top priority.
- - name: MaximumPerformance
- decription: >
- This value shall indicate the system performs at the highest
- speeds possible. This mode should be used when performance is
- the top priority.
- - name: OEM
- description: >
- This value shall indicate the system performs at an OEM-defined
- power mode.
+ - name: Static
+ description: >
+ This value shall indicate the system performs at a static base
+ speed.
+ - name: PowerSaving
+ description: >
+ This value shall indicate the system performs at reduced speeds
+ to save power. This mode should be used when power saving is the
+ top priority.
+ - name: MaximumPerformance
+ decription: >
+ This value shall indicate the system performs at the highest
+ speeds possible. This mode should be used when performance is
+ the top priority.
+ - name: OEM
+ description: >
+ This value shall indicate the system performs at an OEM-defined
+ power mode.
diff --git a/yaml/xyz/openbmc_project/Control/Power/RestorePolicy.interface.yaml b/yaml/xyz/openbmc_project/Control/Power/RestorePolicy.interface.yaml
index 71b970a..34f4217 100644
--- a/yaml/xyz/openbmc_project/Control/Power/RestorePolicy.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Power/RestorePolicy.interface.yaml
@@ -6,7 +6,7 @@
properties:
- name: PowerRestorePolicy
type: enum[self.Policy]
- default: 'Restore'
+ default: "Restore"
description: >
The policy to adopt after the BMC reset.
- name: PowerRestoreDelay
@@ -20,18 +20,18 @@
enumerations:
- name: Policy
description: >
- Possible power restoration policies.
+ Possible power restoration policies.
values:
- - name: None
- description: >
- Perform no power restore logic.
- - name: AlwaysOn
- description: >
- Perform a complete power on process.
- - name: AlwaysOff
- description: >
- Perform a complete power off process.
- - name: Restore
- description: >
- Restore power to last requested state recorded before the BMC was
- reset.
+ - name: None
+ description: >
+ Perform no power restore logic.
+ - name: AlwaysOn
+ description: >
+ Perform a complete power on process.
+ - name: AlwaysOff
+ description: >
+ Perform a complete power off process.
+ - name: Restore
+ description: >
+ Restore power to last requested state recorded before the BMC was
+ reset.
diff --git a/yaml/xyz/openbmc_project/Control/PowerSupplyAttributes.interface.yaml b/yaml/xyz/openbmc_project/Control/PowerSupplyAttributes.interface.yaml
index 1e8f1b3..f943eb9 100644
--- a/yaml/xyz/openbmc_project/Control/PowerSupplyAttributes.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/PowerSupplyAttributes.interface.yaml
@@ -4,7 +4,7 @@
- name: DeratingFactor
type: uint32
flags:
- - const
+ - const
description: >
The power supply derating factor, which is the percentage to multiply
the input power by to get the output power.
diff --git a/yaml/xyz/openbmc_project/Control/PowerSupplyRedundancy.interface.yaml b/yaml/xyz/openbmc_project/Control/PowerSupplyRedundancy.interface.yaml
index 7f7d27b..28b8474 100644
--- a/yaml/xyz/openbmc_project/Control/PowerSupplyRedundancy.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/PowerSupplyRedundancy.interface.yaml
@@ -4,69 +4,69 @@
- name: PowerSupplyRedundancyEnabled
type: boolean
flags:
- - const
+ - const
description: >
When true, the power supplies are redundant.
- name: RotationEnabled
type: boolean
description: >
- Cold redundancy rotation enabled or not.
+ Cold redundancy rotation enabled or not.
- name: RotationAlgorithm
type: enum[self.Algo]
description: >
- Rotation algorithm use for cold redundancy. 0 is BMC Specific, 1 is User
- Specific.
+ Rotation algorithm use for cold redundancy. 0 is BMC Specific, 1 is User
+ Specific.
- name: RotationRankOrder
type: array[byte]
description: >
- The rank order for each PSU, 0 means will not go into cold standby
- state.
+ The rank order for each PSU, 0 means will not go into cold standby
+ state.
- name: PeriodOfRotation
type: uint32
description: >
- Rotation Period for cold redundancy. If rotation algorithm is BMC
- Specific, and rotation is enabled, BMC will change PSU rank order after
- this time. The unit of this PeriodOfRotation is in seconds.
+ Rotation Period for cold redundancy. If rotation algorithm is BMC
+ Specific, and rotation is enabled, BMC will change PSU rank order after
+ this time. The unit of this PeriodOfRotation is in seconds.
- name: ColdRedundancyStatus
type: enum[self.Status]
description: >
- Cold redundancy setting status, set in progress or set completed.
+ Cold redundancy setting status, set in progress or set completed.
- name: PSUNumber
type: byte
description: >
- Number of PSUs are currently on system.
+ Number of PSUs are currently on system.
- name: RedundantCount
type: byte
description: >
- The min number of PSUs in the system required to obtain redundancy
+ The min number of PSUs in the system required to obtain redundancy
default: 2
enumerations:
- name: Algo
description: >
- Rotation algorithm use for cold redundancy.
+ Rotation algorithm use for cold redundancy.
values:
- - name: bmcSpecific
- description: >
- With BMC Specific algorithm, when rotation happen, BMC will add 1 to
- the rank order in each PSU and change the last rank order to the
- first rank order.
- - name: userSpecific
- description: >
- With User Specific algorithm, user need to set the RotationRankOrder
- every time before rotation happen, then BMC will update the rank
- order to PSU.
+ - name: bmcSpecific
+ description: >
+ With BMC Specific algorithm, when rotation happen, BMC will add 1 to
+ the rank order in each PSU and change the last rank order to the
+ first rank order.
+ - name: userSpecific
+ description: >
+ With User Specific algorithm, user need to set the RotationRankOrder
+ every time before rotation happen, then BMC will update the rank
+ order to PSU.
- name: Status
description: >
- Cold redundancy setting status.
+ Cold redundancy setting status.
values:
- - name: inProgress
- description: >
- This status is only use for multi-node system, after any of the
- property setting on one node, before all the nodes sync to same
- value, the status will show in progress.
- - name: completed
- description: >
- For single ndoe system, the status always keep show completed. For
- multi-node system, only after all the nodes sync to same value of
- the properties, the status will be completed.
+ - name: inProgress
+ description: >
+ This status is only use for multi-node system, after any of the
+ property setting on one node, before all the nodes sync to same
+ value, the status will show in progress.
+ - name: completed
+ description: >
+ For single ndoe system, the status always keep show completed. For
+ multi-node system, only after all the nodes sync to same value of
+ the properties, the status will be completed.
diff --git a/yaml/xyz/openbmc_project/Control/Processor/CurrentOperatingConfig.interface.yaml b/yaml/xyz/openbmc_project/Control/Processor/CurrentOperatingConfig.interface.yaml
index d231ba5..d2b24d5 100644
--- a/yaml/xyz/openbmc_project/Control/Processor/CurrentOperatingConfig.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Processor/CurrentOperatingConfig.interface.yaml
@@ -5,24 +5,24 @@
type: object_path
description: Path to currently selected configuration.
errors:
- # Indicate that the set object_path is not a valid associated
- # OperatingConfig.
- - xyz.openbmc_project.Common.Error.InvalidArgument
- # Indicate that this property is permanently unable to be changed.
- - xyz.openbmc_project.Common.Error.NotAllowed
- # Indicate that this property is temporarily unable to be changed.
- - xyz.openbmc_project.Common.Error.Unavailable
- # Indicate a failure to apply changes to the processor.
- - xyz.openbmc_project.Common.Device.Error.WriteFailure
+ # Indicate that the set object_path is not a valid associated
+ # OperatingConfig.
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ # Indicate that this property is permanently unable to be changed.
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ # Indicate that this property is temporarily unable to be changed.
+ - xyz.openbmc_project.Common.Error.Unavailable
+ # Indicate a failure to apply changes to the processor.
+ - xyz.openbmc_project.Common.Device.Error.WriteFailure
- name: BaseSpeedPriorityEnabled
type: boolean
description: >
- Whether base speed prioritization is enabled in the currently selected
- configuration.
+ Whether base speed prioritization is enabled in the currently selected
+ configuration.
errors:
- # Indicate that this property is permanently unable to be changed.
- - xyz.openbmc_project.Common.Error.NotAllowed
- # Indicate that this property is temporarily unable to be changed.
- - xyz.openbmc_project.Common.Error.Unavailable
- # Indicate a failure to apply changes to the processor.
- - xyz.openbmc_project.Common.Device.Error.WriteFailure
+ # Indicate that this property is permanently unable to be changed.
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ # Indicate that this property is temporarily unable to be changed.
+ - xyz.openbmc_project.Common.Error.Unavailable
+ # Indicate a failure to apply changes to the processor.
+ - xyz.openbmc_project.Common.Device.Error.WriteFailure
diff --git a/yaml/xyz/openbmc_project/Control/Security/RestrictionMode.interface.yaml b/yaml/xyz/openbmc_project/Control/Security/RestrictionMode.interface.yaml
index 0baae0e..fa69d7b 100644
--- a/yaml/xyz/openbmc_project/Control/Security/RestrictionMode.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Security/RestrictionMode.interface.yaml
@@ -10,30 +10,30 @@
enumerations:
- name: Modes
description: >
- Possible modes of restriction.
+ Possible modes of restriction.
values:
- - name: None
- description: >
- No restriction.
- - name: Whitelist
- description: >
- Allow, only if in the whitelist.
- - name: Blacklist
- description: >
- Prevent, if in the blacklist.
- - name: Provisioning
- description: >
- Indicate that system is in provisioning mode
- and all commands are allowed in system interface
- in both pre and post BIOS boot.
- - name: ProvisionedHostWhitelist
- description: >
- Commands in the whitelist will only be executed
- through system interface after BIOS POST complete.
- All KCS commands are supported before POST complete.
- - name: ProvisionedHostDisabled
- description: >
- Commands through system interface are executed only
- till BIOS POST complete notification, after
- which system interface commands are blocked (except BIOS SMI
- based ones).
+ - name: None
+ description: >
+ No restriction.
+ - name: Whitelist
+ description: >
+ Allow, only if in the whitelist.
+ - name: Blacklist
+ description: >
+ Prevent, if in the blacklist.
+ - name: Provisioning
+ description: >
+ Indicate that system is in provisioning mode
+ and all commands are allowed in system interface
+ in both pre and post BIOS boot.
+ - name: ProvisionedHostWhitelist
+ description: >
+ Commands in the whitelist will only be executed
+ through system interface after BIOS POST complete.
+ All KCS commands are supported before POST complete.
+ - name: ProvisionedHostDisabled
+ description: >
+ Commands through system interface are executed only
+ till BIOS POST complete notification, after
+ which system interface commands are blocked (except BIOS SMI
+ based ones).
diff --git a/yaml/xyz/openbmc_project/Control/Security/SpecialMode.interface.yaml b/yaml/xyz/openbmc_project/Control/Security/SpecialMode.interface.yaml
index 6760076..e8649a2 100644
--- a/yaml/xyz/openbmc_project/Control/Security/SpecialMode.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Security/SpecialMode.interface.yaml
@@ -10,17 +10,17 @@
enumerations:
- name: Modes
description: >
- Possible modes available.
+ Possible modes available.
values:
- - name: None
- description: >
- BMC is under normal working condition.
- - name: Manufacturing
- description: >
- Indicate that BMC is in manufacturing mode
- and is allowed to perform any manufacturing related
- activity
- - name: ValidationUnsecure
- description: >
- Indicate that BMC is in validation mode, and can
- execute any special validation related commands
+ - name: None
+ description: >
+ BMC is under normal working condition.
+ - name: Manufacturing
+ description: >
+ Indicate that BMC is in manufacturing mode
+ and is allowed to perform any manufacturing related
+ activity
+ - name: ValidationUnsecure
+ description: >
+ Indicate that BMC is in validation mode, and can
+ execute any special validation related commands
diff --git a/yaml/xyz/openbmc_project/Control/Service/SocketAttributes.interface.yaml b/yaml/xyz/openbmc_project/Control/Service/SocketAttributes.interface.yaml
index bf9699e..67a73a7 100644
--- a/yaml/xyz/openbmc_project/Control/Service/SocketAttributes.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Service/SocketAttributes.interface.yaml
@@ -1,13 +1,13 @@
-description: >
- This interface defines the attributes of services which support socket-based
- activation. Applications can expose the port number of a network service by
- implementing this interface. For example, application like
- service-config-manager will implement this interface for network services
- like bmcweb and phosphor-ipmi-net and allow the port number to be configured.
-
-properties:
- - name: Port
- type: uint16
- description: >
- Specifies the port number on which the service is listening. This
- property can be set to configure a port number for the service.
+description: >
+ This interface defines the attributes of services which support socket-based
+ activation. Applications can expose the port number of a network service by
+ implementing this interface. For example, application like
+ service-config-manager will implement this interface for network services
+ like bmcweb and phosphor-ipmi-net and allow the port number to be configured.
+
+properties:
+ - name: Port
+ type: uint16
+ description: >
+ Specifies the port number on which the service is listening. This
+ property can be set to configure a port number for the service.
diff --git a/yaml/xyz/openbmc_project/Control/VoltageRegulatorControl.interface.yaml b/yaml/xyz/openbmc_project/Control/VoltageRegulatorControl.interface.yaml
index 6c29218..db9786b 100644
--- a/yaml/xyz/openbmc_project/Control/VoltageRegulatorControl.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/VoltageRegulatorControl.interface.yaml
@@ -26,4 +26,4 @@
flags:
- readonly
description: >
- The minimum step size supported by this voltage interface.
\ No newline at end of file
+ The minimum step size supported by this voltage interface.
diff --git a/yaml/xyz/openbmc_project/Dump/Create.interface.yaml b/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
index 3daaf2a..f20270a 100644
--- a/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
@@ -9,41 +9,40 @@
systems the instance number can be added to the path to differentiate,
for example /xyz/openbmc_project/dump/<dump type><instance-id>.
-
methods:
- name: CreateDump
description: >
Method to create a manual Dump.
parameters:
- - name: AdditionalData
- type: dict[string, variant[string,uint64]]
- description: >
- The additional data, if any, for initiating the dump.
- The key in this case should be an implementation
- specific enum defined for the specific type of dump
- either in xyz or in a domain.
- The values can be either a string or a 64 bit number.
- The enum-format string is required to come from a
- parallel class with this specific Enum name.
- All of the Enum strings should be in the format
- 'domain.Dump.Create.CreateParameters.ParamName'.
- e.g.:
- {
- "key1": "value1",
- "key2": "value2"
- }
- ends up in AdditionaData like:
- ["KEY1=value1", "KEY2=value2"]
+ - name: AdditionalData
+ type: dict[string, variant[string,uint64]]
+ description: >
+ The additional data, if any, for initiating the dump.
+ The key in this case should be an implementation
+ specific enum defined for the specific type of dump
+ either in xyz or in a domain.
+ The values can be either a string or a 64 bit number.
+ The enum-format string is required to come from a
+ parallel class with this specific Enum name.
+ All of the Enum strings should be in the format
+ 'domain.Dump.Create.CreateParameters.ParamName'.
+ e.g.:
+ {
+ "key1": "value1",
+ "key2": "value2"
+ }
+ ends up in AdditionaData like:
+ ["KEY1=value1", "KEY2=value2"]
returns:
- - name: Path
- type: object_path
- description: >
- The object path of the object that implements
- xyz.openbmc_project.Common.Progress to track the progress
- of the dump
+ - name: Path
+ type: object_path
+ description: >
+ The object path of the object that implements
+ xyz.openbmc_project.Common.Progress to track the progress
+ of the dump
errors:
- - xyz.openbmc_project.Common.File.Error.Write
- - xyz.openbmc_project.Dump.Create.Error.Disabled
- - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded
- - xyz.openbmc_project.Common.Error.NotAllowed
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.File.Error.Write
+ - xyz.openbmc_project.Dump.Create.Error.Disabled
+ - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.InvalidArgument
diff --git a/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml b/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml
index 4e0a109..a71cefa 100644
--- a/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml
@@ -11,24 +11,24 @@
methods:
- name: InitiateOffload
description: >
- This method initiates the offload of the dump from the dump storage.
- The transfer will be initiated to the target provide. The caller of
- this function should set up a method to transfer and pass the URI to
- to this function. If there is no exceptions the caller can assume the
- transfer is successfully initiated. Once the transfer is completed.
- The application which is transferring the dump should set offloaded
- property to true to indicate offload is completed.
+ This method initiates the offload of the dump from the dump storage.
+ The transfer will be initiated to the target provide. The caller of
+ this function should set up a method to transfer and pass the URI to
+ to this function. If there is no exceptions the caller can assume the
+ transfer is successfully initiated. Once the transfer is completed.
+ The application which is transferring the dump should set offloaded
+ property to true to indicate offload is completed.
parameters:
- - name: OffloadUri
- type: string
- description: >
- The location to offload dump file, error InvalidArgument will be
- returned if the URI is not well formated.
+ - name: OffloadUri
+ type: string
+ description: >
+ The location to offload dump file, error InvalidArgument will be
+ returned if the URI is not well formated.
errors:
- - xyz.openbmc_project.Common.File.Error.Open
- - xyz.openbmc_project.Common.File.Error.Write
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.File.Error.Open
+ - xyz.openbmc_project.Common.File.Error.Write
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.NotAllowed
properties:
- name: Size
diff --git a/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml b/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml
index 6fa5809..330f1c2 100644
--- a/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml
@@ -11,19 +11,19 @@
methods:
- name: Notify
description: >
- Create a dump entry based on the parameters.
+ Create a dump entry based on the parameters.
parameters:
- - name: SourceDumpId
- type: uint32
- description: >
- The dump id provided by the source of the dump.
- There are dumps which get generated outside the BMC, like a
- system dump which gets generated and stored in the host memory.
- All dumps will have a unique id but when communicating
- to the source of the dump the SourceDumpId will be used.
- - name: Size
- type: uint64
- description: >
- Size of the dump in bytes
+ - name: SourceDumpId
+ type: uint32
+ description: >
+ The dump id provided by the source of the dump.
+ There are dumps which get generated outside the BMC, like a
+ system dump which gets generated and stored in the host memory.
+ All dumps will have a unique id but when communicating
+ to the source of the dump the SourceDumpId will be used.
+ - name: Size
+ type: uint64
+ description: >
+ Size of the dump in bytes
errors:
- - xyz.openbmc_project.Dump.Create.Error.Disabled
+ - xyz.openbmc_project.Dump.Create.Error.Disabled
diff --git a/yaml/xyz/openbmc_project/HardwareIsolation/Create.interface.yaml b/yaml/xyz/openbmc_project/HardwareIsolation/Create.interface.yaml
index ee8de8c..eed4373 100644
--- a/yaml/xyz/openbmc_project/HardwareIsolation/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/HardwareIsolation/Create.interface.yaml
@@ -11,20 +11,20 @@
can be used if want to isolate hardware without an error log,
for example, the user voluntarily tried to isolate hardware.
parameters:
- - name: IsolateHardware
- type: path
- description: >
- The hardware inventory path which is needs to isolate.
- - name: Severity
- type: enum[xyz.openbmc_project.HardwareIsolation.Entry.Type]
- description: >
- The severity of hardware isolation.
+ - name: IsolateHardware
+ type: path
+ description: >
+ The hardware inventory path which is needs to isolate.
+ - name: Severity
+ type: enum[xyz.openbmc_project.HardwareIsolation.Entry.Type]
+ description: >
+ The severity of hardware isolation.
returns:
- - name: Path
- type: path
- description: >
- The path of created xyz.openbmc_project.HardwareIsolation.Entry
- object.
+ - name: Path
+ type: path
+ description: >
+ The path of created xyz.openbmc_project.HardwareIsolation.Entry
+ object.
errors:
- xyz.openbmc_project.Common.Error.InvalidArgument
- xyz.openbmc_project.Common.Error.TooManyResources
@@ -42,24 +42,24 @@
of this method need to pass the bmc error log which caused
the isolation.
parameters:
- - name: IsolateHardware
- type: path
- description: >
- The hardware inventory path which is needs to isolate.
- - name: Severity
- type: enum[xyz.openbmc_project.HardwareIsolation.Entry.Type]
- description: >
- The severity of hardware isolation.
- - name: BmcErrorLog
- type: path
- description: >
- The BMC error log caused the isolation of hardware.
+ - name: IsolateHardware
+ type: path
+ description: >
+ The hardware inventory path which is needs to isolate.
+ - name: Severity
+ type: enum[xyz.openbmc_project.HardwareIsolation.Entry.Type]
+ description: >
+ The severity of hardware isolation.
+ - name: BmcErrorLog
+ type: path
+ description: >
+ The BMC error log caused the isolation of hardware.
returns:
- - name: Path
- type: path
- description: >
- The path of created xyz.openbmc_project.HardwareIsolation.Entry
- object.
+ - name: Path
+ type: path
+ description: >
+ The path of created xyz.openbmc_project.HardwareIsolation.Entry
+ object.
errors:
- xyz.openbmc_project.Common.Error.InvalidArgument
- xyz.openbmc_project.Common.Error.TooManyResources
diff --git a/yaml/xyz/openbmc_project/HardwareIsolation/Entry.interface.yaml b/yaml/xyz/openbmc_project/HardwareIsolation/Entry.interface.yaml
index 492baac..bc49434 100644
--- a/yaml/xyz/openbmc_project/HardwareIsolation/Entry.interface.yaml
+++ b/yaml/xyz/openbmc_project/HardwareIsolation/Entry.interface.yaml
@@ -38,15 +38,15 @@
description: >
Possible severity for hardware isolation.
values:
- - name: Critical
- description: >
- Critical hardware to repair or replace.
- - name: Warning
- description: >
- The system can boot without the isolated hardware but,
- will lose the system configuration benefits of isolated
- hardware.
- - name: Manual
- description: >
- A user attempted to isolate hardware to proceed with
- the host to boot.
+ - name: Critical
+ description: >
+ Critical hardware to repair or replace.
+ - name: Warning
+ description: >
+ The system can boot without the isolated hardware but,
+ will lose the system configuration benefits of isolated
+ hardware.
+ - name: Manual
+ description: >
+ A user attempted to isolate hardware to proceed with
+ the host to boot.
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/AssetTag.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/AssetTag.interface.yaml
index 3b3e047..01ed714 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/AssetTag.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/AssetTag.interface.yaml
@@ -6,4 +6,3 @@
type: string
description: >
The tag provided to an object to identify it.
-
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/LocationCode.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/LocationCode.interface.yaml
index a549b68..3ca7145 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/LocationCode.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/LocationCode.interface.yaml
@@ -3,8 +3,7 @@
properties:
- name: LocationCode
type: string
- description:
- A free form, implementation defined string to provide
+ description: A free form, implementation defined string to provide
location code of an Inventory Item.
Location codes can be used to identify specific parts
in a system. Although this field should not be used for
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/UniqueIdentifier.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/UniqueIdentifier.interface.yaml
index 7c44513..fbfc423 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/UniqueIdentifier.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/UniqueIdentifier.interface.yaml
@@ -4,7 +4,7 @@
- name: UniqueIdentifier
type: string
description: >
- A free form, implementation defined string which uniquely and
- permanently identifies a specific inventory item. This is complementary
- to the item's serial number. This field should not be used for
- programmatic interrogation of an object.
+ A free form, implementation defined string which uniquely and
+ permanently identifies a specific inventory item. This is complementary
+ to the item's serial number. This field should not be used for
+ programmatic interrogation of an object.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Accelerator.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Accelerator.interface.yaml
index 3bb3a01..b6ed9d5 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Accelerator.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Accelerator.interface.yaml
@@ -7,7 +7,7 @@
properties:
- name: Type
type: enum[self.AcceleratorType]
- default: 'Unknown'
+ default: "Unknown"
description: >
The type of accelerator.
@@ -16,15 +16,15 @@
description: >
Possible accelerator type
values:
- - name: 'ASIC'
- description: >
- An ASIC.
- - name: 'FPGA'
- description: >
- An FPGA.
- - name: 'GPU'
- description: >
- A GPU.
- - name: 'Unknown'
- description: >
- An unknown type.
+ - name: "ASIC"
+ description: >
+ An ASIC.
+ - name: "FPGA"
+ description: >
+ An FPGA.
+ - name: "GPU"
+ description: >
+ A GPU.
+ - name: "Unknown"
+ description: >
+ An unknown type.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Chassis.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Chassis.interface.yaml
index 13b279f..597ec4b 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Chassis.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Chassis.interface.yaml
@@ -13,33 +13,33 @@
description: >
Possible chassis type
values:
- - name: Component
- description: >
- A small chassis, card, or device that contains devices for a
- particular subsystem or function.
- - name: Enclosure
- description: >
- A generic term for a chassis that does not fit any other
- description.
- - name: Module
- description: >
- A small, typically removable, chassis or card that contains
- devices for a particular subsystem or function.
- - name: RackMount
- description: >
- A single-system chassis designed specifically for mounting in an
- equipment rack.
- - name: StandAlone
- description: >
- A single, free-standing system, commonly called a tower or
- desktop chassis.
- - name: StorageEnclosure
- description: >
- A chassis that encloses storage.
- - name: Unknown
- description: >
- An unknown chassis type.
- - name: Zone
- description: >
- A logical division or portion of a physical chassis that contains
- multiple devices or systems that cannot be physically separated.
+ - name: Component
+ description: >
+ A small chassis, card, or device that contains devices for a
+ particular subsystem or function.
+ - name: Enclosure
+ description: >
+ A generic term for a chassis that does not fit any other
+ description.
+ - name: Module
+ description: >
+ A small, typically removable, chassis or card that contains
+ devices for a particular subsystem or function.
+ - name: RackMount
+ description: >
+ A single-system chassis designed specifically for mounting in an
+ equipment rack.
+ - name: StandAlone
+ description: >
+ A single, free-standing system, commonly called a tower or
+ desktop chassis.
+ - name: StorageEnclosure
+ description: >
+ A chassis that encloses storage.
+ - name: Unknown
+ description: >
+ An unknown chassis type.
+ - name: Zone
+ description: >
+ A logical division or portion of a physical chassis that contains
+ multiple devices or systems that cannot be physically separated.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Cpu.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Cpu.interface.yaml
index 53eca3e..95df804 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Cpu.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Cpu.interface.yaml
@@ -68,24 +68,24 @@
List of capabilities that a processor can support.
Values are based off DMTF DSP0134 specification.
values:
- - name: Capable64bit
- description: >
- Capable of 64-bit.
- - name: MultiCore
- description: >
- Support multi-core.
- - name: HardwareThread
- description: >
- Support hardware thread.
- - name: ExecuteProtection
- description: >
- Support execute protection.
- - name: EnhancedVirtualization
- description: >
- Support enhanced virtualization.
- - name: PowerPerformanceControl
- description: >
- Support power/performance control.
+ - name: Capable64bit
+ description: >
+ Capable of 64-bit.
+ - name: MultiCore
+ description: >
+ Support multi-core.
+ - name: HardwareThread
+ description: >
+ Support hardware thread.
+ - name: ExecuteProtection
+ description: >
+ Support execute protection.
+ - name: EnhancedVirtualization
+ description: >
+ Support enhanced virtualization.
+ - name: PowerPerformanceControl
+ description: >
+ Support power/performance control.
associations:
- name: associated_pcie_slots
@@ -95,4 +95,4 @@
PCIe slots.
reverse_name: upstream_processor
required_endpoint_interfaces:
- - xyz.openbmc_project.Inventory.Item.PCIeSlot
+ - xyz.openbmc_project.Inventory.Item.PCIeSlot
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Cpu/OperatingConfig.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Cpu/OperatingConfig.interface.yaml
index 0d0463a..2460505 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Cpu/OperatingConfig.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Cpu/OperatingConfig.interface.yaml
@@ -6,44 +6,44 @@
type: uint32
description: The base clock speed of the processor in MHz.
flags:
- - readonly
+ - readonly
- name: BaseSpeedPrioritySettings
type: array[struct[uint32, array[uint32]]]
description: >
- An array of objects that specify the base clock frequency for sets of
- cores when the configuration is operational. Each entry contains two
- members, first is the base clock speed in MHz, and second is an array
- identifying the set of core IDs to configure at that base speed.
+ An array of objects that specify the base clock frequency for sets of
+ cores when the configuration is operational. Each entry contains two
+ members, first is the base clock speed in MHz, and second is an array
+ identifying the set of core IDs to configure at that base speed.
flags:
- - readonly
+ - readonly
- name: MaxJunctionTemperature
type: uint32
description: The maximum temperature of the junction in degrees Celsius.
flags:
- - readonly
+ - readonly
- name: MaxSpeed
type: uint32
description: >
- The maximum clock speed to which the processor can be configured in MHz.
+ The maximum clock speed to which the processor can be configured in MHz.
flags:
- - readonly
+ - readonly
- name: PowerLimit
type: uint32
description: The thermal design point of the processor in watts.
flags:
- - readonly
+ - readonly
- name: AvailableCoreCount
type: size
description: >
- The number of cores in the processor that can be used in this
- configuration.
+ The number of cores in the processor that can be used in this
+ configuration.
flags:
- - readonly
+ - readonly
- name: TurboProfile
type: array[struct[uint32, size]]
description: >
- An array of objects that specify the turbo profile for a set of active
- cores. Each entry contains two members, first is the maximum turbo clock
- speed in MHz, and second is number of cores which can run at that speed.
+ An array of objects that specify the turbo profile for a set of active
+ cores. Each entry contains two members, first is the maximum turbo clock
+ speed in MHz, and second is number of cores which can run at that speed.
flags:
- - readonly
+ - readonly
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/CpuCore.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/CpuCore.interface.yaml
index b68b6c0..2639d71 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/CpuCore.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/CpuCore.interface.yaml
@@ -6,4 +6,3 @@
description: >
The microcode information for this processor
default: 0
-
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Dimm.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Dimm.interface.yaml
index 4164691..d3a7df7 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Dimm.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Dimm.interface.yaml
@@ -72,196 +72,196 @@
description: >
Error-Correcting Code.
values:
- - name: NoECC
- description: >
- No ECC support.
- - name: SingleBitECC
- description: >
- Single bit data errors can be corrected by ECC.
- - name: MultiBitECC
- description: >
- Multibit data errors can be corrected by ECC.
- - name: AddressParity
- description: >
- Address parity errors can be corrected.
+ - name: NoECC
+ description: >
+ No ECC support.
+ - name: SingleBitECC
+ description: >
+ Single bit data errors can be corrected by ECC.
+ - name: MultiBitECC
+ description: >
+ Multibit data errors can be corrected by ECC.
+ - name: AddressParity
+ description: >
+ Address parity errors can be corrected.
- name: MemoryTech
description: >
This property shall contain the type ofmemory that this Resource
represents.
values:
- - name: Other
- description: >
- Some devices which are not defined in SMBIOS table.
- - name: Unknown
- description: >
- Unknown device.
- - name: DRAM
- description: >
- The memory module is comprised of volatile memory.
- - name: NVDIMM_N
- description: >
- The memory module is comprised of volatile memory backed by
- non-volatile memory.
- - name: NVDIMM_F
- description: >
- The memory module is comprised of non-volatile memory.
- - name: NVDIMM_P
- description: >
- The memory module is comprised of a combination of non-volatile
- and volatile memory.
- - name: IntelOptane
- description: >
- The memory module is an Intel Optane DC Persistent Memory Module.
+ - name: Other
+ description: >
+ Some devices which are not defined in SMBIOS table.
+ - name: Unknown
+ description: >
+ Unknown device.
+ - name: DRAM
+ description: >
+ The memory module is comprised of volatile memory.
+ - name: NVDIMM_N
+ description: >
+ The memory module is comprised of volatile memory backed by
+ non-volatile memory.
+ - name: NVDIMM_F
+ description: >
+ The memory module is comprised of non-volatile memory.
+ - name: NVDIMM_P
+ description: >
+ The memory module is comprised of a combination of non-volatile
+ and volatile memory.
+ - name: IntelOptane
+ description: >
+ The memory module is an Intel Optane DC Persistent Memory Module.
- name: DeviceType
description: >
This property shall contain the Memory Device Type as defined by
SMBIOS.
values:
- - name: Other
- description: >
- Some devices which are not defined in this table.
- - name: Unknown
- description: >
- Unknown device.
- - name: DRAM
- description: >
- Dynamic Random Access Memory.
- - name: EDRAM
- description: >
- Enhanced Dynamic Random Access Memory.
- - name: VRAM
- description: >
- Video Random Access Memory.
- - name: SRAM
- description: >
- Static Random Access Memory.
- - name: RAM
- description: >
- Random Access Memory.
- - name: ROM
- description: >
- Read Only Memory.
- - name: FLASH
- description: >
- Flash Memory.
- - name: EEPROM
- description: >
- Electrically Erasable Programmable Read Only Memory.
- - name: FEPROM
- description: >
- Flash Erasable Programmable Read Only Memory.
- - name: EPROM
- description: >
- Erasable Programmable Read Only Memory.
- - name: CDRAM
- description: >
- Cached Dynamic Random Access Memory.
- - name: ThreeDRAM
- description: >
- Three Dimensional Random Access Memory.
- - name: SDRAM
- description: >
- Synchronous Dynamic Random Access Memory.
- - name: DDR_SGRAM
- description: >
- Double Data Rate Synchronous Graphics Random-Access Memory.
- - name: RDRAM
- description: >
- Direct Rambus Dynamic Random Access Memory.
- - name: DDR
- description: >
- Double Data Rate SDRAM.
- - name: DDR2
- description: >
- Double Data Rate 2 SDRAM.
- - name: DDR2_SDRAM_FB_DIMM
- description: >
- DDR2 SDRAM Fully Buffered DIMM.
- - name: EDO
- description: >
- Extended Data Output Memory.
- - name: FastPageMode
- description: >
- Fast Page Mode Memory.
- - name: PipelinedNibble
- description: >
- Pipelined Nibble Memory.
- - name: DDR3
- description: >
- Double Data Rate 3 SDRAM.
- - name: FBD2
- description: >
- Fully Buffered DIMM 2.
- - name: DDR4
- description: >
- Double Data Rate 4 SDRAM.
- - name: LPDDR_SDRAM
- description: >
- Low-Power Double Data Rate SDRAM.
- - name: LPDDR2_SDRAM
- description: >
- Low-Power Double Data Rate 2 SDRAM.
- - name: LPDDR3_SDRAM
- description: >
- Low-Power Double Data Rate 3 SDRAM.
- - name: LPDDR4_SDRAM
- description: >
- Low-Power Double Data Rate 4 SDRAM.
- - name: Logical
- description: >
- Logical Non-volatile device.
- - name: HBM
- description: >
- High Bandwidth Memory
- - name: HBM2
- description: >
- High Bandwidth Memory Generation 2.
- - name: DDR2_SDRAM_FB_DIMM_PROB
- description: >
- DDR2 SDRAM Fully Buffered DIMM PROBE.
- - name: DDR4E_SDRAM
- description: >
- Double Data Rate 4 Extended Compliant SDRAM.
- - name: DDR5
- description: >
- Double Data Rate 5 SDRAM.
- - name: LPDDR5_SDRAM
- description: >
- Low-Power Double Data Rate 5 SDRAM.
+ - name: Other
+ description: >
+ Some devices which are not defined in this table.
+ - name: Unknown
+ description: >
+ Unknown device.
+ - name: DRAM
+ description: >
+ Dynamic Random Access Memory.
+ - name: EDRAM
+ description: >
+ Enhanced Dynamic Random Access Memory.
+ - name: VRAM
+ description: >
+ Video Random Access Memory.
+ - name: SRAM
+ description: >
+ Static Random Access Memory.
+ - name: RAM
+ description: >
+ Random Access Memory.
+ - name: ROM
+ description: >
+ Read Only Memory.
+ - name: FLASH
+ description: >
+ Flash Memory.
+ - name: EEPROM
+ description: >
+ Electrically Erasable Programmable Read Only Memory.
+ - name: FEPROM
+ description: >
+ Flash Erasable Programmable Read Only Memory.
+ - name: EPROM
+ description: >
+ Erasable Programmable Read Only Memory.
+ - name: CDRAM
+ description: >
+ Cached Dynamic Random Access Memory.
+ - name: ThreeDRAM
+ description: >
+ Three Dimensional Random Access Memory.
+ - name: SDRAM
+ description: >
+ Synchronous Dynamic Random Access Memory.
+ - name: DDR_SGRAM
+ description: >
+ Double Data Rate Synchronous Graphics Random-Access Memory.
+ - name: RDRAM
+ description: >
+ Direct Rambus Dynamic Random Access Memory.
+ - name: DDR
+ description: >
+ Double Data Rate SDRAM.
+ - name: DDR2
+ description: >
+ Double Data Rate 2 SDRAM.
+ - name: DDR2_SDRAM_FB_DIMM
+ description: >
+ DDR2 SDRAM Fully Buffered DIMM.
+ - name: EDO
+ description: >
+ Extended Data Output Memory.
+ - name: FastPageMode
+ description: >
+ Fast Page Mode Memory.
+ - name: PipelinedNibble
+ description: >
+ Pipelined Nibble Memory.
+ - name: DDR3
+ description: >
+ Double Data Rate 3 SDRAM.
+ - name: FBD2
+ description: >
+ Fully Buffered DIMM 2.
+ - name: DDR4
+ description: >
+ Double Data Rate 4 SDRAM.
+ - name: LPDDR_SDRAM
+ description: >
+ Low-Power Double Data Rate SDRAM.
+ - name: LPDDR2_SDRAM
+ description: >
+ Low-Power Double Data Rate 2 SDRAM.
+ - name: LPDDR3_SDRAM
+ description: >
+ Low-Power Double Data Rate 3 SDRAM.
+ - name: LPDDR4_SDRAM
+ description: >
+ Low-Power Double Data Rate 4 SDRAM.
+ - name: Logical
+ description: >
+ Logical Non-volatile device.
+ - name: HBM
+ description: >
+ High Bandwidth Memory
+ - name: HBM2
+ description: >
+ High Bandwidth Memory Generation 2.
+ - name: DDR2_SDRAM_FB_DIMM_PROB
+ description: >
+ DDR2 SDRAM Fully Buffered DIMM PROBE.
+ - name: DDR4E_SDRAM
+ description: >
+ Double Data Rate 4 Extended Compliant SDRAM.
+ - name: DDR5
+ description: >
+ Double Data Rate 5 SDRAM.
+ - name: LPDDR5_SDRAM
+ description: >
+ Low-Power Double Data Rate 5 SDRAM.
- name: FormFactor
description: >
Implementation form factor for this memory device.
values:
- - name: RDIMM
- description: >
- Registered DIMM.
- - name: UDIMM
- description: >
- Unbuffered DIMM.
- - name: SO_DIMM
- description: >
- Small Outline DIMM.
- - name: LRDIMM
- description: >
- Load-reduced DIMMs.
- - name: Mini_RDIMM
- description: >
- mini Registered DIMM.
- - name: Mini_UDIMM
- description: >
- mini Unbuffered DIMM.
- - name: SO_RDIMM_72b
- description: >
- Small Outline Registered DIMM.
- - name: SO_UDIMM_72b
- description: >
- Small Outline Unbuffered DIMM.
- - name: SO_DIMM_16b
- description: >
- Small Outline DIMM 16 bit.
- - name: SO_DIMM_32b
- description: >
- Small Outline DIMM 32 bit.
- - name: Die
- description: >
- A die within a package.
+ - name: RDIMM
+ description: >
+ Registered DIMM.
+ - name: UDIMM
+ description: >
+ Unbuffered DIMM.
+ - name: SO_DIMM
+ description: >
+ Small Outline DIMM.
+ - name: LRDIMM
+ description: >
+ Load-reduced DIMMs.
+ - name: Mini_RDIMM
+ description: >
+ mini Registered DIMM.
+ - name: Mini_UDIMM
+ description: >
+ mini Unbuffered DIMM.
+ - name: SO_RDIMM_72b
+ description: >
+ Small Outline Registered DIMM.
+ - name: SO_UDIMM_72b
+ description: >
+ Small Outline Unbuffered DIMM.
+ - name: SO_DIMM_16b
+ description: >
+ Small Outline DIMM 16 bit.
+ - name: SO_DIMM_32b
+ description: >
+ Small Outline DIMM 32 bit.
+ - name: Die
+ description: >
+ A die within a package.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation.interface.yaml
index 43e838f..6e9e48d 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation.interface.yaml
@@ -17,4 +17,4 @@
- name: Slot
type: byte
description: >
- Slot of given channel.
\ No newline at end of file
+ Slot of given channel.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PCIeDevice.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PCIeDevice.interface.yaml
index ab2b49a..a710268 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PCIeDevice.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PCIeDevice.interface.yaml
@@ -10,12 +10,12 @@
Indicates if the device is MultiFunction or SingleFunction.
- name: GenerationInUse
type: enum[xyz.openbmc_project.Inventory.Item.PCIeSlot.Generations]
- default: 'Unknown'
+ default: "Unknown"
description: >
The PCIe interface generation in use by the device.
- name: GenerationSupported
type: enum[xyz.openbmc_project.Inventory.Item.PCIeSlot.Generations]
- default: 'Unknown'
+ default: "Unknown"
description: >
The maximum PCIe generation supported by the device.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PCIeSlot.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PCIeSlot.interface.yaml
index 570514e..5c0f0d5 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PCIeSlot.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PCIeSlot.interface.yaml
@@ -5,7 +5,7 @@
properties:
- name: Generation
type: enum[self.Generations]
- default: 'Unknown'
+ default: "Unknown"
description: >
The PCIe generation of the slot
@@ -16,7 +16,7 @@
- name: SlotType
type: enum[self.SlotTypes]
- default: 'Unknown'
+ default: "Unknown"
description: >
The type of the slot
@@ -30,73 +30,73 @@
description: >
Possible PCIe generations
values:
- - name: 'Gen1'
- description: >
- PCIe v1.0 slot
+ - name: "Gen1"
+ description: >
+ PCIe v1.0 slot
- - name: 'Gen2'
- description: >
- PCIe v2.0 slot
+ - name: "Gen2"
+ description: >
+ PCIe v2.0 slot
- - name: 'Gen3'
- description: >
- PCIe v3.0 slot
+ - name: "Gen3"
+ description: >
+ PCIe v3.0 slot
- - name: 'Gen4'
- description: >
- PCIe v4.0 slot
+ - name: "Gen4"
+ description: >
+ PCIe v4.0 slot
- - name: 'Gen5'
- description: >
- PCIe v5.0 slot
+ - name: "Gen5"
+ description: >
+ PCIe v5.0 slot
- - name: 'Unknown'
- description: >
- Version of the PCIe slot is unknown
+ - name: "Unknown"
+ description: >
+ Version of the PCIe slot is unknown
- name: SlotTypes
description: >
Possible types of a PCIe slot
values:
- - name: 'FullLength'
- description: >
- Full-Length PCIe slot
+ - name: "FullLength"
+ description: >
+ Full-Length PCIe slot
- - name: 'HalfLength'
- description: >
- Half-Length PCIe slot
+ - name: "HalfLength"
+ description: >
+ Half-Length PCIe slot
- - name: 'LowProfile'
- description: >
- Low-Profile or Slim PCIe slot
+ - name: "LowProfile"
+ description: >
+ Low-Profile or Slim PCIe slot
- - name: 'Mini'
- description: >
- Mini PCIe slot
+ - name: "Mini"
+ description: >
+ Mini PCIe slot
- - name: 'M_2'
- description: >
- PCIe M.2 slot
+ - name: "M_2"
+ description: >
+ PCIe M.2 slot
- - name: 'OEM'
- description: >
- An OEM-specific PCIe slot
+ - name: "OEM"
+ description: >
+ An OEM-specific PCIe slot
- - name: 'OCP3Small'
- description: >
- Open Compute Project 3.0 small form factor PCIe slot
+ - name: "OCP3Small"
+ description: >
+ Open Compute Project 3.0 small form factor PCIe slot
- - name: 'OCP3Large'
- description: >
- Open Compute Project 3.0 large form factor PCIe slot
+ - name: "OCP3Large"
+ description: >
+ Open Compute Project 3.0 large form factor PCIe slot
- - name: 'U_2'
- description: >
- U.2 / SFF-8639 PCIe slot or bay
+ - name: "U_2"
+ description: >
+ U.2 / SFF-8639 PCIe slot or bay
- - name: 'Unknown'
- description: >
- Type of the PCIe slot is unknown
+ - name: "Unknown"
+ description: >
+ Type of the PCIe slot is unknown
associations:
- name: upstream_processor
@@ -106,4 +106,4 @@
bridge or on-processor PCIe root complexes.
reverse_name: associated_pcie_slots
required_endpoint_interfaces:
- - xyz.openbmc_project.Inventory.Item.Cpu
+ - xyz.openbmc_project.Inventory.Item.Cpu
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory.interface.yaml
index 9396726..16c9d08 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory.interface.yaml
@@ -98,12 +98,12 @@
description: >
Memory modes supported by the memory module.
values:
- - name: Volatile
- description: >
- Memory module supports volatile or non-persistent memory mode.
- - name: Persistent
- description: >
- Memory module supports apt direct mode.
- - name: Block
- description: >
- Memory module supports block mode.
\ No newline at end of file
+ - name: Volatile
+ description: >
+ Memory module supports volatile or non-persistent memory mode.
+ - name: Persistent
+ description: >
+ Memory module supports apt direct mode.
+ - name: Block
+ description: >
+ Memory module supports block mode.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/PowerManagementPolicy.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/PowerManagementPolicy.interface.yaml
index d5231d7..5d067ec 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/PowerManagementPolicy.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/PowerManagementPolicy.interface.yaml
@@ -17,4 +17,4 @@
- name: AveragePowerBudgetmW
type: uint32
description: >
- Average power budget in milliwatts.
\ No newline at end of file
+ Average power budget in milliwatts.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/SecurityCapabilities.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/SecurityCapabilities.interface.yaml
index 23ca54e..09a6856 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/SecurityCapabilities.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/SecurityCapabilities.interface.yaml
@@ -21,4 +21,4 @@
type: uint32
description: >
The maximum number of incorrect passphrase attempts
- allowed before memory is locked.
\ No newline at end of file
+ allowed before memory is locked.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Rotor.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Rotor.interface.yaml
index 4f8d931..c403032 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Rotor.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Rotor.interface.yaml
@@ -7,14 +7,14 @@
- name: NominalVoltage
type: double
description: >
- The nominal voltage of the fan in mV.
+ The nominal voltage of the fan in mV.
- name: NominalCurrent
type: double
description: >
- The nominal maximum current of the fan in mA.
+ The nominal maximum current of the fan in mA.
- name: NominalRPM
type: double
description: >
- The nominal speed of the fan in RPMs.
+ The nominal speed of the fan in RPMs.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Volume.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Volume.interface.yaml
index fab0db8..4388da3 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Volume.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Volume.interface.yaml
@@ -6,119 +6,119 @@
methods:
- name: FormatLuks
description: >
- Format a LUKS encrypted device and create a filesystem.
+ Format a LUKS encrypted device and create a filesystem.
parameters:
- - name: Password
- type: array[byte]
- description: >
- Array of bytes to use as the LUKS password.
- - name: Type
- type: enum[self.FilesystemType]
- description: >
- Type of filesystem, e.g. ext2, ext3, ext4, vfat.
+ - name: Password
+ type: array[byte]
+ description: >
+ Array of bytes to use as the LUKS password.
+ - name: Type
+ type: enum[self.FilesystemType]
+ description: >
+ Type of filesystem, e.g. ext2, ext3, ext4, vfat.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.ResourceNotFound
- - xyz.openbmc_project.Common.Error.UnsupportedRequest
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.UnsupportedRequest
- name: Erase
description: >
- Erase the contents of the volume.
+ Erase the contents of the volume.
parameters:
- - name: EraseType
- type: enum[self.EraseMethod]
- description: >
- Describes what type of erase is done.
+ - name: EraseType
+ type: enum[self.EraseMethod]
+ description: >
+ Describes what type of erase is done.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
- name: Lock
description: >
- Unmount the filesystem, lock the volume, and remove sensitive data
- (e.g. volume key) from memory.
+ Unmount the filesystem, lock the volume, and remove sensitive data
+ (e.g. volume key) from memory.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.UnsupportedRequest
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.UnsupportedRequest
- name: Unlock
description: >
- Activate the volume and mount the filesystem.
+ Activate the volume and mount the filesystem.
parameters:
- - name: Password
- type: array[byte]
- description: >
- Array of bytes to use as the LUKS password.
+ - name: Password
+ type: array[byte]
+ description: >
+ Array of bytes to use as the LUKS password.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
- name: ChangePassword
description: >
- Change the LUKS password that unlocks the storage volume.
+ Change the LUKS password that unlocks the storage volume.
parameters:
- - name: OldPassword
- type: array[byte]
- description: >
- Array of bytes for the old LUKS password.
- - name: NewPassword
- type: array[byte]
- description: >
- Array of bytes to use as the LUKS password.
+ - name: OldPassword
+ type: array[byte]
+ description: >
+ Array of bytes for the old LUKS password.
+ - name: NewPassword
+ type: array[byte]
+ description: >
+ Array of bytes to use as the LUKS password.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
properties:
- name: Locked
type: boolean
default: false
description: >
- Indicates whether the LUKS volume is locked.
+ Indicates whether the LUKS volume is locked.
enumerations:
- name: EraseMethod
description: >
- Indicates which erase method/step is being requested.
+ Indicates which erase method/step is being requested.
values:
- - name: CryptoErase
- description: >
- Destroys the encryption key slots, preventing decyrption.
- - name: VerifyGeometry
- description: >
- Confirms a set percent of the disk is accessible.
- - name: LogicalOverWrite
- description: >
- Overwrites the disk with a reproducible incompressible pattern.
- - name: LogicalVerify
- description: >
- Verifies a reproducible pattern has been written to the disk.
- - name: VendorSanitize
- description: >
- Uses the sanitization provided by the device firmware.
- - name: ZeroOverWrite
- description: >
- Writes zeros over the whole disk.
- - name: ZeroVerify
- description: >
- Verifies the the entire disk has been zeroed.
- - name: SecuredLocked
- description: >
- Locks the disk to prevent data being written to it.
+ - name: CryptoErase
+ description: >
+ Destroys the encryption key slots, preventing decyrption.
+ - name: VerifyGeometry
+ description: >
+ Confirms a set percent of the disk is accessible.
+ - name: LogicalOverWrite
+ description: >
+ Overwrites the disk with a reproducible incompressible pattern.
+ - name: LogicalVerify
+ description: >
+ Verifies a reproducible pattern has been written to the disk.
+ - name: VendorSanitize
+ description: >
+ Uses the sanitization provided by the device firmware.
+ - name: ZeroOverWrite
+ description: >
+ Writes zeros over the whole disk.
+ - name: ZeroVerify
+ description: >
+ Verifies the the entire disk has been zeroed.
+ - name: SecuredLocked
+ description: >
+ Locks the disk to prevent data being written to it.
- name: FilesystemType
description: >
- Type of filesystem used on the storage device.
+ Type of filesystem used on the storage device.
values:
- - name: ext2
- description: >
- Filesystem type ext2
- - name: ext3
- description: >
- Filesystem type ext3
- - name: ext4
- description: >
- Filesystem type ext4
- - name: vfat
- description: >
- Filesystem type vfat
+ - name: ext2
+ description: >
+ Filesystem type ext2
+ - name: ext3
+ description: >
+ Filesystem type ext3
+ - name: ext4
+ description: >
+ Filesystem type ext4
+ - name: vfat
+ description: >
+ Filesystem type vfat
diff --git a/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml
index 6f32fcb..6c791ee 100644
--- a/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml
@@ -11,7 +11,7 @@
Signal the implementing service that an item is ready to have its
state managed.
parameters:
- - name: object
- type: dict[path,dict[string,dict[string,variant[boolean,size,int64,string,array[byte]]]]]
- description: >
- A dictionary of fully enumerated items to be managed.
+ - name: object
+ type: dict[path,dict[string,dict[string,variant[boolean,size,int64,string,array[byte]]]]]
+ description: >
+ A dictionary of fully enumerated items to be managed.
diff --git a/yaml/xyz/openbmc_project/Ipmi/SOL.interface.yaml b/yaml/xyz/openbmc_project/Ipmi/SOL.interface.yaml
index 96c8c87..52dedbf 100644
--- a/yaml/xyz/openbmc_project/Ipmi/SOL.interface.yaml
+++ b/yaml/xyz/openbmc_project/Ipmi/SOL.interface.yaml
@@ -10,43 +10,43 @@
- name: Progress
type: byte
description: >
- Set In Progress property, indicate when any parameters are being
- updated.
+ Set In Progress property, indicate when any parameters are being
+ updated.
- name: Enable
type: boolean
description: >
- SOL Enable property, this controls whether the SOL payload type
- can be activated.
+ SOL Enable property, this controls whether the SOL payload type
+ can be activated.
- name: ForceEncryption
type: boolean
description: >
- If SOL enable Force Payload Encryption.
+ If SOL enable Force Payload Encryption.
- name: ForceAuthentication
type: boolean
description: >
- If SOL enable Force Payload Authentication
+ If SOL enable Force Payload Authentication
- name: Privilege
type: byte
description: >
- Sets the minimum operating privilege level that is required to
- be able to activate SOL by Activate Payload command.
+ Sets the minimum operating privilege level that is required to
+ be able to activate SOL by Activate Payload command.
- name: AccumulateIntervalMS
type: byte
description: >
- Character Accumulate Interval in 5ms increments.
- BMC will wait this time before transmitting a packet.
+ Character Accumulate Interval in 5ms increments.
+ BMC will wait this time before transmitting a packet.
- name: Threshold
type: byte
description: >
- BMC will automatically send an SOL character data packet containing
- this number of characters as soon as this number of characters
- (or greater) has been accepted from the baseboard serial controller.
+ BMC will automatically send an SOL character data packet containing
+ this number of characters as soon as this number of characters
+ (or greater) has been accepted from the baseboard serial controller.
- name: RetryCount
type: byte
description: >
- Packet will be dropped if no ACK/NACK received by time retries
- expire.
+ Packet will be dropped if no ACK/NACK received by time retries
+ expire.
- name: RetryIntervalMS
type: byte
description: >
- Retry Interval in 10ms increments.
+ Retry Interval in 10ms increments.
diff --git a/yaml/xyz/openbmc_project/Ipmi/SessionInfo.interface.yaml b/yaml/xyz/openbmc_project/Ipmi/SessionInfo.interface.yaml
index 0ddc025..6d8a899 100644
--- a/yaml/xyz/openbmc_project/Ipmi/SessionInfo.interface.yaml
+++ b/yaml/xyz/openbmc_project/Ipmi/SessionInfo.interface.yaml
@@ -43,7 +43,7 @@
- name: UserID
type: byte
description: >
- Session created by given user ID.
+ Session created by given user ID.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
- name: State
diff --git a/yaml/xyz/openbmc_project/Led/Group.interface.yaml b/yaml/xyz/openbmc_project/Led/Group.interface.yaml
index 121fe80..56caba2 100644
--- a/yaml/xyz/openbmc_project/Led/Group.interface.yaml
+++ b/yaml/xyz/openbmc_project/Led/Group.interface.yaml
@@ -4,5 +4,5 @@
- name: Asserted
type: boolean
description: >
- Whether or not the group is currently asserted.
- To assert a group, set to True. To de-assert a group, set to False.
+ Whether or not the group is currently asserted.
+ To assert a group, set to True. To de-assert a group, set to False.
diff --git a/yaml/xyz/openbmc_project/Led/Physical.interface.yaml b/yaml/xyz/openbmc_project/Led/Physical.interface.yaml
index f4f9784..5378dfe 100644
--- a/yaml/xyz/openbmc_project/Led/Physical.interface.yaml
+++ b/yaml/xyz/openbmc_project/Led/Physical.interface.yaml
@@ -4,59 +4,59 @@
properties:
- name: State
type: enum[self.Action]
- default: 'Off'
+ default: "Off"
description: >
- Current State of the LED.
+ Current State of the LED.
- name: DutyOn
type: byte
default: 50
description: >
- Percentage time the LED needs to be ON while blinking.
+ Percentage time the LED needs to be ON while blinking.
- name: Color
type: enum[self.Palette]
default: Unknown
description: >
- Color that the LED can emit.
+ Color that the LED can emit.
- name: Period
type: uint16
default: 1000
description: >
- LED blink period expressed as milliseconds per on/off cycle.
+ LED blink period expressed as milliseconds per on/off cycle.
enumerations:
- name: Action
description: >
Possible states a LED can be in.
values:
- - name: 'Off'
- description: >
- LED is in OFF state
- - name: 'On'
- description: >
- LED is in solid ON state
- - name: 'Blink'
- description: >
- LED is blinking
+ - name: "Off"
+ description: >
+ LED is in OFF state
+ - name: "On"
+ description: >
+ LED is in solid ON state
+ - name: "Blink"
+ description: >
+ LED is blinking
- name: Palette
description: >
Possible colors that the LED can emit.
values:
- - name: Unknown
- description: >
- Color emitted by LED is unknown.
- - name: Red
- description: >
- LED can emit Red color.
- - name: Green
- description: >
- LED can emit Green color.
- - name: Blue
- description: >
- LED can emit Blue color.
- - name: Yellow
- description: >
- LED can emit Yellow color.
+ - name: Unknown
+ description: >
+ Color emitted by LED is unknown.
+ - name: Red
+ description: >
+ LED can emit Red color.
+ - name: Green
+ description: >
+ LED can emit Green color.
+ - name: Blue
+ description: >
+ LED can emit Blue color.
+ - name: Yellow
+ description: >
+ LED can emit Yellow color.
diff --git a/yaml/xyz/openbmc_project/Logging/Create.interface.yaml b/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
index 15b709d..9798b76 100644
--- a/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
@@ -9,25 +9,25 @@
description: >
Create a xyz.openbmc_project.Logging.Entry object.
parameters:
- - name: Message
- type: string
- description: >
- The Message property of the event entry.
- - name: Severity
- type: enum[xyz.openbmc_project.Logging.Entry.Level]
- description: >
- The Severity property of the event entry.
- - name: AdditionalData
- type: dict[string, string]
- description: >
- The AdditionalData property of the event entry.
- e.g.:
- {
- "key1": "value1",
- "key2": "value2"
- }
- ends up in AdditionaData like:
- ["KEY1=value1", "KEY2=value2"]
+ - name: Message
+ type: string
+ description: >
+ The Message property of the event entry.
+ - name: Severity
+ type: enum[xyz.openbmc_project.Logging.Entry.Level]
+ description: >
+ The Severity property of the event entry.
+ - name: AdditionalData
+ type: dict[string, string]
+ description: >
+ The AdditionalData property of the event entry.
+ e.g.:
+ {
+ "key1": "value1",
+ "key2": "value2"
+ }
+ ends up in AdditionaData like:
+ ["KEY1=value1", "KEY2=value2"]
- name: CreateWithFFDCFiles
description: >
@@ -41,58 +41,57 @@
When the method call is complete the descriptors must be closed and
the files can be deleted if desired.
parameters:
- - name: Message
- type: string
- description: >
- The Message property of the event entry.
- - name: Severity
- type: enum[xyz.openbmc_project.Logging.Entry.Level]
- description: >
- The Severity property of the event entry.
- - name: AdditionalData
- type: dict[string, string]
- description: >
- The AdditionalData property of the event entry.
- e.g.:
- {
- "key1": "value1",
- "key2": "value2"
- }
- ends up in AdditionaData like:
- ["KEY1=value1", "KEY2=value2"]
- - name: FFDC
- type: array[struct[enum[self.FFDCFormat], byte, byte, unixfd]]
- description: >
- File descriptors for any files containing FFDC, along with metadata
- about the contents:
+ - name: Message
+ type: string
+ description: >
+ The Message property of the event entry.
+ - name: Severity
+ type: enum[xyz.openbmc_project.Logging.Entry.Level]
+ description: >
+ The Severity property of the event entry.
+ - name: AdditionalData
+ type: dict[string, string]
+ description: >
+ The AdditionalData property of the event entry.
+ e.g.:
+ {
+ "key1": "value1",
+ "key2": "value2"
+ }
+ ends up in AdditionaData like:
+ ["KEY1=value1", "KEY2=value2"]
+ - name: FFDC
+ type: array[struct[enum[self.FFDCFormat], byte, byte, unixfd]]
+ description: >
+ File descriptors for any files containing FFDC, along with metadata
+ about the contents:
- FFDCFormat- The format type of the contained data.
- subType - The format subtype, used for the 'Custom' type.
- version - The version of the data format, used for the 'Custom'
- type.
- unixfd - The file descriptor to the data file.
+ FFDCFormat- The format type of the contained data.
+ subType - The format subtype, used for the 'Custom' type.
+ version - The version of the data format, used for the 'Custom'
+ type.
+ unixfd - The file descriptor to the data file.
- e.g.:
- [
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0, 5},
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2, 6}
- ]
-
+ e.g.:
+ [
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0, 5},
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2, 6}
+ ]
enumerations:
- name: FFDCFormat
description: >
- format types
+ format types
values:
- - name: JSON
- description: >
- Valid fully formed JSON, e.g. {"foo":"bar"}
- - name: CBOR
- description: >
- Valid CBOR (Concise Binary Object Representation)
- - name: Text
- description: >
- ASCII text
- - name: Custom
- description: >
- Something other than the above formats
+ - name: JSON
+ description: >
+ Valid fully formed JSON, e.g. {"foo":"bar"}
+ - name: CBOR
+ description: >
+ Valid CBOR (Concise Binary Object Representation)
+ - name: Text
+ description: >
+ ASCII text
+ - name: Custom
+ description: >
+ Something other than the above formats
diff --git a/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml b/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
index 991f038..348bb91 100644
--- a/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
@@ -67,38 +67,38 @@
description: >
Possible severity levels for an error log entry.
values:
- - name: Emergency
- description: >
- System is unusable.
- - name: Alert
- description: >
- Should be corrected immediately.
- - name: Critical
- description: >
- Critical condition.
- - name: Error
- description: >
- Error condition.
- - name: Warning
- description: >
- An error may occur if action is not taken.
- - name: Notice
- description: >
- Unusual condition, but not an error.
- - name: Informational
- description: >
- Normal operational message that does not require action.
- - name: Debug
- description: >
- Information useful to developers for debugging the application.
+ - name: Emergency
+ description: >
+ System is unusable.
+ - name: Alert
+ description: >
+ Should be corrected immediately.
+ - name: Critical
+ description: >
+ Critical condition.
+ - name: Error
+ description: >
+ Error condition.
+ - name: Warning
+ description: >
+ An error may occur if action is not taken.
+ - name: Notice
+ description: >
+ Unusual condition, but not an error.
+ - name: Informational
+ description: >
+ Normal operational message that does not require action.
+ - name: Debug
+ description: >
+ Information useful to developers for debugging the application.
methods:
- - name: GetEntry
- description: >
- Returns the file descriptor to the raw Entry file, which is a binary blob.
- The mode of the file descriptor is to be reaad-only.
- returns:
- - name: fd
- type: unixfd
- description: >
- The file descriptor to the Entry file.
+ - name: GetEntry
+ description: >
+ Returns the file descriptor to the raw Entry file, which is a binary blob.
+ The mode of the file descriptor is to be reaad-only.
+ returns:
+ - name: fd
+ type: unixfd
+ description: >
+ The file descriptor to the Entry file.
diff --git a/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml b/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
index 54e24b8..517a346 100644
--- a/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
@@ -19,105 +19,105 @@
methods:
- name: IpmiSelAdd
description: >
- Log a system event record type SEL entry.
+ Log a system event record type SEL entry.
parameters:
- - name: Message
- type: string
- description: >
- The text to log for the event.
- - name: Path
- type: path
- description: >
- The object path that is generating the SEL entry.
- - name: SELData
- type: array[byte]
- description: >
- An array of up to 3 bytes of SEL event data.
- - name: Assert
- type: boolean
- description: >
- An indicator if the SEL event is asserting or de-asserting.
- - name: GeneratorID
- type: uint16
- description: >
- The Generator ID of the component requesting the new SEL entry.
- In most cases this will be 0x20 (the BMC Generator ID).
+ - name: Message
+ type: string
+ description: >
+ The text to log for the event.
+ - name: Path
+ type: path
+ description: >
+ The object path that is generating the SEL entry.
+ - name: SELData
+ type: array[byte]
+ description: >
+ An array of up to 3 bytes of SEL event data.
+ - name: Assert
+ type: boolean
+ description: >
+ An indicator if the SEL event is asserting or de-asserting.
+ - name: GeneratorID
+ type: uint16
+ description: >
+ The Generator ID of the component requesting the new SEL entry.
+ In most cases this will be 0x20 (the BMC Generator ID).
returns:
- - name: RecordID
- type: uint16
- description: >
- The Record ID of the new SEL entry.
+ - name: RecordID
+ type: uint16
+ description: >
+ The Record ID of the new SEL entry.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: AddExtended
description: >
- Log a system event record SEL entry with custom SensorType/EventType.
+ Log a system event record SEL entry with custom SensorType/EventType.
parameters:
- - name: Message
- type: string
- description: >
- The text to log for the event.
- - name: Path
- type: path
- description: >
- The object path that is generating the SEL entry.
- - name: SELData
- type: array[byte]
- description: >
- An array of up to 3 bytes of SEL event data.
- - name: GeneratorID
- type: uint16
- description: >
- The Generator ID of the component requesting the new SEL entry.
- In most cases this will be 0x20 (the BMC Generator ID).
- - name: eventType
- type: byte
- description: >
- Type of trigger for the event and event direction.
- - name: sensorType
- type: byte
- description: >
- Sensor Type Code for sensor that generated the event.
- - name: sensorNum
- type: byte
- description: >
- Number of sensor that generated the event.
+ - name: Message
+ type: string
+ description: >
+ The text to log for the event.
+ - name: Path
+ type: path
+ description: >
+ The object path that is generating the SEL entry.
+ - name: SELData
+ type: array[byte]
+ description: >
+ An array of up to 3 bytes of SEL event data.
+ - name: GeneratorID
+ type: uint16
+ description: >
+ The Generator ID of the component requesting the new SEL entry.
+ In most cases this will be 0x20 (the BMC Generator ID).
+ - name: eventType
+ type: byte
+ description: >
+ Type of trigger for the event and event direction.
+ - name: sensorType
+ type: byte
+ description: >
+ Sensor Type Code for sensor that generated the event.
+ - name: sensorNum
+ type: byte
+ description: >
+ Number of sensor that generated the event.
returns:
- - name: RecordID
- type: uint16
- description: >
- The Record ID of the new SEL entry.
+ - name: RecordID
+ type: uint16
+ description: >
+ The Record ID of the new SEL entry.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: IpmiSelAddOem
description: >
- Log an OEM record type SEL entry requested from external to the BMC.
+ Log an OEM record type SEL entry requested from external to the BMC.
parameters:
- - name: Message
- type: string
- description: >
- The text to log for the event.
- - name: SELData
- type: array[byte]
- description: >
- An array of up to 13 bytes of SEL event data.
- - name: RecordType
- type: byte
- description: >
- The OEM record type for the SEL entry.
+ - name: Message
+ type: string
+ description: >
+ The text to log for the event.
+ - name: SELData
+ type: array[byte]
+ description: >
+ An array of up to 13 bytes of SEL event data.
+ - name: RecordType
+ type: byte
+ description: >
+ The OEM record type for the SEL entry.
returns:
- - name: RecordID
- type: uint16
- description: >
- The Record ID of the new SEL entry.
+ - name: RecordID
+ type: uint16
+ description: >
+ The Record ID of the new SEL entry.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: Clear
description: >
- Clear the SEL entries from their storage location.
+ Clear the SEL entries from their storage location.
diff --git a/yaml/xyz/openbmc_project/MCTP/Endpoint.interface.yaml b/yaml/xyz/openbmc_project/MCTP/Endpoint.interface.yaml
index 119f1c6..8cb0f13 100644
--- a/yaml/xyz/openbmc_project/MCTP/Endpoint.interface.yaml
+++ b/yaml/xyz/openbmc_project/MCTP/Endpoint.interface.yaml
@@ -6,7 +6,6 @@
MCTP-capable management controllers and managed devices.
properties:
-
- name: NetworkId
type: size
description: >
diff --git a/yaml/xyz/openbmc_project/Memory/MemoryECC.errors.yaml b/yaml/xyz/openbmc_project/Memory/MemoryECC.errors.yaml
index 9c2f4b9..2cdb66b 100644
--- a/yaml/xyz/openbmc_project/Memory/MemoryECC.errors.yaml
+++ b/yaml/xyz/openbmc_project/Memory/MemoryECC.errors.yaml
@@ -5,4 +5,4 @@
description: Correctable ECC/other correctable memory error.
- name: ueCount
- description: Uncorrectable ECC/other uncorrectable memory error.
\ No newline at end of file
+ description: Uncorrectable ECC/other uncorrectable memory error.
diff --git a/yaml/xyz/openbmc_project/Memory/MemoryECC.interface.yaml b/yaml/xyz/openbmc_project/Memory/MemoryECC.interface.yaml
index 32c23bb..8cd5704 100644
--- a/yaml/xyz/openbmc_project/Memory/MemoryECC.interface.yaml
+++ b/yaml/xyz/openbmc_project/Memory/MemoryECC.interface.yaml
@@ -20,19 +20,19 @@
The state is described in ECC status.
enumerations:
- - name: ECCStatus
- description: >
- The operating system statuses.
- values:
- - name: ok
- description: >
- There is no ECC error occurred.
- - name: CE
- description: >
- correctable ECC detected.
- - name: UE
- description: >
- uncorrectable ECC detected.
- - name: LogFull
- description: >
- ECC logging reach limits.
+ - name: ECCStatus
+ description: >
+ The operating system statuses.
+ values:
+ - name: ok
+ description: >
+ There is no ECC error occurred.
+ - name: CE
+ description: >
+ correctable ECC detected.
+ - name: UE
+ description: >
+ uncorrectable ECC detected.
+ - name: LogFull
+ description: >
+ ECC logging reach limits.
diff --git a/yaml/xyz/openbmc_project/Network/Client.interface.yaml b/yaml/xyz/openbmc_project/Network/Client.interface.yaml
index 8c8eaeb..188bcd9 100644
--- a/yaml/xyz/openbmc_project/Network/Client.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/Client.interface.yaml
@@ -9,11 +9,11 @@
description: >
The value of this property can be IP/hostname of the network endpoint.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
- name: Port
type: uint16
description: >
The value of this property is the network port number.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/Network/Client/Create.interface.yaml b/yaml/xyz/openbmc_project/Network/Client/Create.interface.yaml
index 77955d5..d904762 100644
--- a/yaml/xyz/openbmc_project/Network/Client/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/Client/Create.interface.yaml
@@ -4,18 +4,18 @@
description: >
Create network client endpoint.
parameters:
- - name: Address
- type: string
- description: >
- IP Address/Hostname
- - name: Port
- type: uint16
- description: >
- Network port.
+ - name: Address
+ type: string
+ description: >
+ IP Address/Hostname
+ - name: Port
+ type: uint16
+ description: >
+ Network port.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InvalidArgument
returns:
- - name: path
- type: string
- description: >
- Path of the object which has been created.
+ - name: path
+ type: string
+ description: >
+ Path of the object which has been created.
diff --git a/yaml/xyz/openbmc_project/Network/EthernetInterface.interface.yaml b/yaml/xyz/openbmc_project/Network/EthernetInterface.interface.yaml
index d8b6d2f..09ddf04 100644
--- a/yaml/xyz/openbmc_project/Network/EthernetInterface.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/EthernetInterface.interface.yaml
@@ -3,7 +3,6 @@
An object implementing this interface must implement
xyz.openbmc_project.State.OperationalStatus.
-
properties:
- name: InterfaceName
type: string
@@ -47,7 +46,7 @@
provided addresses, or in cases where the DHCP server provides no DNS
assigments.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: NTPServers
type: array[string]
description: >
@@ -82,7 +81,7 @@
description: >
Default IPv4 gateway of the ethernet interface.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: DefaultGateway6
type: string
description: >
@@ -91,24 +90,24 @@
Refer below man page for both v4 and v6 address format details
https://man7.org/linux/man-pages/man3/inet_pton.3.html
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InvalidArgument
enumerations:
- name: LinkLocalConf
description: >
Possible link local auto configuration values.
values:
- - name: fallback
- - name: both
- - name: v4
- - name: v6
- - name: none
+ - name: fallback
+ - name: both
+ - name: v4
+ - name: v6
+ - name: none
- name: DHCPConf
description: >
A list of the permitted DHCP settings used by systemd.
values:
- - name: both
- - name: v4
- - name: v6
- - name: none
+ - name: both
+ - name: v4
+ - name: v6
+ - name: none
diff --git a/yaml/xyz/openbmc_project/Network/Experimental/Bond.interface.yaml b/yaml/xyz/openbmc_project/Network/Experimental/Bond.interface.yaml
index 2120875..f0b3472 100644
--- a/yaml/xyz/openbmc_project/Network/Experimental/Bond.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/Experimental/Bond.interface.yaml
@@ -30,56 +30,56 @@
description: >
Possible bonding mode types.
values:
- - name: RoundRobin
- description: >
- It is the default mode,in this mode system transmits packets in
- sequential order from the first available slave through the last.
- - name: ActiveBackup
- description: >
- In this mode, only one slave in the bond is active.
- The other one will become active, only when the active slave fails.
- - name: XOR
- description: >
- Transmit based on selectable hashing algorithm.
- The default policy is a simple source+destination MAC address algorithm.
- - name: Broadcast
- description: >
- Transmits everything on all slave interfaces.
- - name: Dynamic
- description: >
- IEEE 802.3ad Dynamic link aggregation.
- - name: TLB
- description: >
- The outgoing traffic is distributed according to the current load on each slave.
- - name: ALB
- description: >
- Incoming/outgoing traffic is distributed according to the current load on each slave.
+ - name: RoundRobin
+ description: >
+ It is the default mode,in this mode system transmits packets in
+ sequential order from the first available slave through the last.
+ - name: ActiveBackup
+ description: >
+ In this mode, only one slave in the bond is active.
+ The other one will become active, only when the active slave fails.
+ - name: XOR
+ description: >
+ Transmit based on selectable hashing algorithm.
+ The default policy is a simple source+destination MAC address algorithm.
+ - name: Broadcast
+ description: >
+ Transmits everything on all slave interfaces.
+ - name: Dynamic
+ description: >
+ IEEE 802.3ad Dynamic link aggregation.
+ - name: TLB
+ description: >
+ The outgoing traffic is distributed according to the current load on each slave.
+ - name: ALB
+ description: >
+ Incoming/outgoing traffic is distributed according to the current load on each slave.
- name: HashPolicy
description: >
Possible policy types.
values:
- - name: Layer2
- description: >
- This policy uses XOR of hardware MAC addresses and packet type ID
- field to generate the hash.
- - name: Layer2Plus3
- description: >
- This policy uses a combination of layer2 and layer3
- protocol information to generate the hash.
- - name: Layer3Plus4
- description: >
- This policy uses upper layer protocol information,
- when available, to generate the hash.
- - name: Encap2Plus3
- description: >
- This policy uses the same formula as layer2+3 but it
- relies on skb_flow_dissect to obtain the header fields
- which might result in the use of inner headers if an
- encapsulation protocol is used.
- - name: Encap3Plus4
- description: >
- This policy uses the same formula as layer3+4 but it
- relies on skb_flow_dissect to obtain the header fields
- which might result in the use of inner headers if an
- encapsulation protocol is used.
+ - name: Layer2
+ description: >
+ This policy uses XOR of hardware MAC addresses and packet type ID
+ field to generate the hash.
+ - name: Layer2Plus3
+ description: >
+ This policy uses a combination of layer2 and layer3
+ protocol information to generate the hash.
+ - name: Layer3Plus4
+ description: >
+ This policy uses upper layer protocol information,
+ when available, to generate the hash.
+ - name: Encap2Plus3
+ description: >
+ This policy uses the same formula as layer2+3 but it
+ relies on skb_flow_dissect to obtain the header fields
+ which might result in the use of inner headers if an
+ encapsulation protocol is used.
+ - name: Encap3Plus4
+ description: >
+ This policy uses the same formula as layer3+4 but it
+ relies on skb_flow_dissect to obtain the header fields
+ which might result in the use of inner headers if an
+ encapsulation protocol is used.
diff --git a/yaml/xyz/openbmc_project/Network/Experimental/Tunnel.interface.yaml b/yaml/xyz/openbmc_project/Network/Experimental/Tunnel.interface.yaml
index 89e3039..fe2bdae 100644
--- a/yaml/xyz/openbmc_project/Network/Experimental/Tunnel.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/Experimental/Tunnel.interface.yaml
@@ -71,12 +71,12 @@
description: >
Possible IPv6 tunnel types.
values:
- - name: ip6ip6
- description: >
- IPv6 over IPv6.
- - name: ipip6
- description: >
- IPv4 over IPv6.
- - name: any
- description: >
- Either ip6ip6 or ipip6.
+ - name: ip6ip6
+ description: >
+ IPv6 over IPv6.
+ - name: ipip6
+ description: >
+ IPv4 over IPv6.
+ - name: any
+ description: >
+ Either ip6ip6 or ipip6.
diff --git a/yaml/xyz/openbmc_project/Network/IP.interface.yaml b/yaml/xyz/openbmc_project/Network/IP.interface.yaml
index 5091ac9..8490873 100644
--- a/yaml/xyz/openbmc_project/Network/IP.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/IP.interface.yaml
@@ -46,22 +46,22 @@
description: >
Possible IP protocol types.
values:
- - name: IPv4
- - name: IPv6
+ - name: IPv4
+ - name: IPv6
- name: AddressOrigin
description: >
Possible IP address origin types.
values:
- - name: Static
- description: >
- Static address configured by the server.
- - name: DHCP
- description: >
- Address is provided by a DHCP service.
- - name: LinkLocal
- description: >
- Address is valid only for this network segment.
- - name: SLAAC
- description: >
- Address is provided by a Stateless Address Autoconfiguration.
+ - name: Static
+ description: >
+ Static address configured by the server.
+ - name: DHCP
+ description: >
+ Address is provided by a DHCP service.
+ - name: LinkLocal
+ description: >
+ Address is valid only for this network segment.
+ - name: SLAAC
+ description: >
+ Address is provided by a Stateless Address Autoconfiguration.
diff --git a/yaml/xyz/openbmc_project/Network/MACAddress.interface.yaml b/yaml/xyz/openbmc_project/Network/MACAddress.interface.yaml
index 243770d..5ec8cd9 100644
--- a/yaml/xyz/openbmc_project/Network/MACAddress.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/MACAddress.interface.yaml
@@ -9,6 +9,6 @@
two hexadecimal digits separated by colons.
Example: 01:23:45:67:89:AB
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.NotAllowed
diff --git a/yaml/xyz/openbmc_project/Network/Neighbor.interface.yaml b/yaml/xyz/openbmc_project/Network/Neighbor.interface.yaml
index a2c4161..ecc38ec 100644
--- a/yaml/xyz/openbmc_project/Network/Neighbor.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/Neighbor.interface.yaml
@@ -23,8 +23,8 @@
description: >
The internal state of the neighbor entry.
values:
- - name: Incomplete
- - name: Reachable
- - name: Stale
- - name: Invalid
- - name: Permanent
+ - name: Incomplete
+ - name: Reachable
+ - name: Stale
+ - name: Invalid
+ - name: Permanent
diff --git a/yaml/xyz/openbmc_project/Network/SystemConfiguration.interface.yaml b/yaml/xyz/openbmc_project/Network/SystemConfiguration.interface.yaml
index 29033fb..0fc0ef7 100644
--- a/yaml/xyz/openbmc_project/Network/SystemConfiguration.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/SystemConfiguration.interface.yaml
@@ -13,10 +13,10 @@
description: >
default IPv4 gateway of the system.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: DefaultGateway6
type: string
description: >
default IPv6 gateway of the system.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InvalidArgument
diff --git a/yaml/xyz/openbmc_project/Network/VLAN.interface.yaml b/yaml/xyz/openbmc_project/Network/VLAN.interface.yaml
index bac27d7..873b1b7 100644
--- a/yaml/xyz/openbmc_project/Network/VLAN.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/VLAN.interface.yaml
@@ -5,11 +5,11 @@
# creatable: true
properties:
- - name: InterfaceName
- type: string
- description: >
- Name of the interface.
- - name: Id
- type: uint32
- description: >
- VLAN Identifier.
+ - name: InterfaceName
+ type: string
+ description: >
+ Name of the interface.
+ - name: Id
+ type: uint32
+ description: >
+ VLAN Identifier.
diff --git a/yaml/xyz/openbmc_project/Nvme/Status.errors.yaml b/yaml/xyz/openbmc_project/Nvme/Status.errors.yaml
index b5037ed..2314f4f 100644
--- a/yaml/xyz/openbmc_project/Nvme/Status.errors.yaml
+++ b/yaml/xyz/openbmc_project/Nvme/Status.errors.yaml
@@ -2,15 +2,15 @@
description: The available spare capacity has fallen below the threshold
- name: TemperatureFault
- description: A temperature is above an over temperature threshold or below an under temperature threshold
+ description: A temperature is above an over temperature threshold or below an under temperature threshold
- name: DegradesFault
description: The NVM subsystem reliability has been
- degraded due to significant media related errors or any
- internal error that degrades NVM subsystem reliability.
+ degraded due to significant media related errors or any
+ internal error that degrades NVM subsystem reliability.
- name: MediaFault
description: The media has been placed in read only mode.
- name: BackupDeviceFault
- description: The volatile memory backup device has failed.
\ No newline at end of file
+ description: The volatile memory backup device has failed.
diff --git a/yaml/xyz/openbmc_project/Object/Delete.interface.yaml b/yaml/xyz/openbmc_project/Object/Delete.interface.yaml
index de592d3..b56d7e0 100644
--- a/yaml/xyz/openbmc_project/Object/Delete.interface.yaml
+++ b/yaml/xyz/openbmc_project/Object/Delete.interface.yaml
@@ -5,6 +5,6 @@
description: >
Delete the object implementing Delete.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.NotAllowed
- - xyz.openbmc_project.Common.Error.Unavailable
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.Unavailable
diff --git a/yaml/xyz/openbmc_project/Object/Enable.interface.yaml b/yaml/xyz/openbmc_project/Object/Enable.interface.yaml
index f0a5b2f..41567c7 100644
--- a/yaml/xyz/openbmc_project/Object/Enable.interface.yaml
+++ b/yaml/xyz/openbmc_project/Object/Enable.interface.yaml
@@ -18,8 +18,8 @@
- name: Enabled
type: boolean
description: >
- Whether the object is enabled or not. Implementation may throw error
- "NotAllowed" depends on the context how it is used.
+ Whether the object is enabled or not. Implementation may throw error
+ "NotAllowed" depends on the context how it is used.
default: false
errors:
- - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.NotAllowed
diff --git a/yaml/xyz/openbmc_project/ObjectMapper.interface.yaml b/yaml/xyz/openbmc_project/ObjectMapper.interface.yaml
index f76d48d..02f327a 100644
--- a/yaml/xyz/openbmc_project/ObjectMapper.interface.yaml
+++ b/yaml/xyz/openbmc_project/ObjectMapper.interface.yaml
@@ -9,89 +9,89 @@
Obtain a dictionary of service -> implemented interface(s)
for the given path.
parameters:
- - name: path
- type: path
- description: >
- The object path for which the result should be fetched.
- - name: interfaces
- type: array[string]
- description: >
- An array of result set constraining interfaces.
+ - name: path
+ type: path
+ description: >
+ The object path for which the result should be fetched.
+ - name: interfaces
+ type: array[string]
+ description: >
+ An array of result set constraining interfaces.
returns:
- - name: services
- type: dict[string,array[string]]
- description: >
- A dictionary of service -> implemented interface(s).
+ - name: services
+ type: dict[string,array[string]]
+ description: >
+ A dictionary of service -> implemented interface(s).
errors:
- - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
- name: GetAncestors
description: >
Obtain a dictionary of ancestor -> services where ancestor is an
ancestor of path and services is of the type returned by the
GetObject method.
parameters:
- - name: path
- type: path
- description: >
- The path for which the result should be fetched.
- - name: interfaces
- type: array[string]
- description: >
- An array of result set constraining interfaces.
+ - name: path
+ type: path
+ description: >
+ The path for which the result should be fetched.
+ - name: interfaces
+ type: array[string]
+ description: >
+ An array of result set constraining interfaces.
returns:
- - name: ancestors
- type: dict[path,dict[string,array[string]]]
- description: >
- A dictionary of ancestor -> services.
+ - name: ancestors
+ type: dict[path,dict[string,array[string]]]
+ description: >
+ A dictionary of ancestor -> services.
errors:
- - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
- name: GetSubTree
description: >
Obtain a dictionary of path -> services where path is in
sutbtree and services is of the type returned by the
GetObject method.
parameters:
- - name: subtree
- type: path
- description: >
- The subtree path for which the result should be fetched.
- - name: depth
- type: int32
- description: >
- The maximum subtree depth for which results should be fetched.
- For unconstrained fetches use a depth of zero.
- - name: interfaces
- type: array[string]
- description: >
- An array of result set constraining interfaces.
+ - name: subtree
+ type: path
+ description: >
+ The subtree path for which the result should be fetched.
+ - name: depth
+ type: int32
+ description: >
+ The maximum subtree depth for which results should be fetched.
+ For unconstrained fetches use a depth of zero.
+ - name: interfaces
+ type: array[string]
+ description: >
+ An array of result set constraining interfaces.
returns:
- - name: objects
- type: dict[path,dict[string,array[string]]]
- description: >
- A dictionary of path -> services.
+ - name: objects
+ type: dict[path,dict[string,array[string]]]
+ description: >
+ A dictionary of path -> services.
errors:
- - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
- name: GetSubTreePaths
description: >
Obtain an array of paths where array elements are in subtree.
parameters:
- - name: subtree
- type: path
- description: >
- The subtree path for which the result should be fetched.
- - name: depth
- type: int32
- description: >
- The maximum subtree depth for which results should be fetched.
- For unconstrained fetches use a depth of zero.
- - name: interfaces
- type: array[string]
- description: >
- An array of result set constraining interfaces.
+ - name: subtree
+ type: path
+ description: >
+ The subtree path for which the result should be fetched.
+ - name: depth
+ type: int32
+ description: >
+ The maximum subtree depth for which results should be fetched.
+ For unconstrained fetches use a depth of zero.
+ - name: interfaces
+ type: array[string]
+ description: >
+ An array of result set constraining interfaces.
returns:
- - name: paths
- type: array[path]
- description: >
- An array of paths.
+ - name: paths
+ type: array[path]
+ description: >
+ An array of paths.
errors:
- - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
diff --git a/yaml/xyz/openbmc_project/PLDM/Event.interface.yaml b/yaml/xyz/openbmc_project/PLDM/Event.interface.yaml
index 77c7355..62fa083 100644
--- a/yaml/xyz/openbmc_project/PLDM/Event.interface.yaml
+++ b/yaml/xyz/openbmc_project/PLDM/Event.interface.yaml
@@ -22,33 +22,32 @@
More information about properties can be found at DSP0248 version
1.2.0 table 19.
properties:
- - name: TID
- type: byte
- description: >
- A terminus id.
+ - name: TID
+ type: byte
+ description: >
+ A terminus id.
- - name: sensorID
- type: uint16
- description: >
- The sensorID is the value that is used in PDRs and PLDM sensor
- access commands to identify and access a particular sensor
- within a terminus.
+ - name: sensorID
+ type: uint16
+ description: >
+ The sensorID is the value that is used in PDRs and PLDM sensor
+ access commands to identify and access a particular sensor
+ within a terminus.
- - name: sensorOffset
- type: byte
- description: >
- Identifies which state sensor within a composite state sensor
- the event is being returned for.
+ - name: sensorOffset
+ type: byte
+ description: >
+ Identifies which state sensor within a composite state sensor
+ the event is being returned for.
- - name: eventState
- type: byte
- description: >
- The event state value from the state change that triggered
- the event message.
+ - name: eventState
+ type: byte
+ description: >
+ The event state value from the state change that triggered
+ the event message.
- - name: previousEventState
- type: byte
- description: >
- The event state value for the state from which the present
- event state was entered.
-
+ - name: previousEventState
+ type: byte
+ description: >
+ The event state value for the state from which the present
+ event state was entered.
diff --git a/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml b/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml
index 7c44229..dcdec47 100644
--- a/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml
+++ b/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml
@@ -13,7 +13,6 @@
More information about PDR can be found at DSP0248 version 1.2.0 section 25.
-
methods:
- name: FindStateEffecterPDR
description: >
@@ -28,43 +27,43 @@
exception will be thrown.
parameters:
- - name: TID
- type: byte
- description: >
- A terminus id.
+ - name: TID
+ type: byte
+ description: >
+ A terminus id.
- - name: EntityID
- type: uint16
- description: >
- A numeric value that represents an entity that can be associated to
- a PLDM state set.
+ - name: EntityID
+ type: uint16
+ description: >
+ A numeric value that represents an entity that can be associated to
+ a PLDM state set.
- More information is found at
- http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
- section 7.
+ More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
+ section 7.
- - name: StateSetId
- type: uint16
- description: >
- A numeric value that identifies the PLDM State Set that is used with
- this sensor.
+ - name: StateSetId
+ type: uint16
+ description: >
+ A numeric value that identifies the PLDM State Set that is used with
+ this sensor.
- More information is found at
- http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
- section 6.
+ More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
+ section 6.
returns:
- - name: StateEffecterPDR
- type: array[array[byte]]
- description: >
- Array of State Effecter PDRs, where a PDR is an array[byte].
- Multiple PDRs of the format present in table 89 of DSP0248 version
- 1.2.0 are returned. Each of the PDRs returned has the common header
- along with all the other fields in table 89 and 90 of
- DSP0248 of version 1.2.0 .
+ - name: StateEffecterPDR
+ type: array[array[byte]]
+ description: >
+ Array of State Effecter PDRs, where a PDR is an array[byte].
+ Multiple PDRs of the format present in table 89 of DSP0248 version
+ 1.2.0 are returned. Each of the PDRs returned has the common header
+ along with all the other fields in table 89 and 90 of
+ DSP0248 of version 1.2.0 .
errors:
- - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
- name: FindStateSensorPDR
description: >
@@ -79,33 +78,33 @@
xyz.openbmc_project.Common.Error.ResourceNotFound exception will be thrown.
parameters:
- - name: TID
- type: byte
- description: >
- A terminus id.
+ - name: TID
+ type: byte
+ description: >
+ A terminus id.
- - name: EntityID
- type: uint16
- description: >
- A numeric value that represents an entity that can be associated to a PLDM state set.
- More information is found at
- http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 7.
+ - name: EntityID
+ type: uint16
+ description: >
+ A numeric value that represents an entity that can be associated to a PLDM state set.
+ More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 7.
- - name: StateSetId
- type: uint16
- description: >
- A numeric value that identifies the PLDM State Set that is used with this sensor.
- More information is found at
- http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 6.
+ - name: StateSetId
+ type: uint16
+ description: >
+ A numeric value that identifies the PLDM State Set that is used with this sensor.
+ More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 6.
returns:
- - name: StateSensorPDR
- type: array[array[byte]]
- description: >
- Array of State Sensor PDRs, where a PDR is an array[byte]. Multiple PDRs of the
- format present in table 80 of DSP0248 version 1.2.0 are returned. Each of the PDRs
- returned has the common header along with all the other fields in table 80 and 81 of
- DSP0248 of version 1.2.0 .
+ - name: StateSensorPDR
+ type: array[array[byte]]
+ description: >
+ Array of State Sensor PDRs, where a PDR is an array[byte]. Multiple PDRs of the
+ format present in table 80 of DSP0248 version 1.2.0 are returned. Each of the PDRs
+ returned has the common header along with all the other fields in table 80 and 81 of
+ DSP0248 of version 1.2.0 .
errors:
- - xyz.openbmc_project.Common.Error.ResourceNotFound
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
diff --git a/yaml/xyz/openbmc_project/PLDM/Provider/Certs/Authority/CSR.interface.yaml b/yaml/xyz/openbmc_project/PLDM/Provider/Certs/Authority/CSR.interface.yaml
index e2bf5a7..efee306 100644
--- a/yaml/xyz/openbmc_project/PLDM/Provider/Certs/Authority/CSR.interface.yaml
+++ b/yaml/xyz/openbmc_project/PLDM/Provider/Certs/Authority/CSR.interface.yaml
@@ -14,4 +14,4 @@
Should be a valid PEM encoded CSR string.
It's a const property.
flags:
- - const
+ - const
diff --git a/yaml/xyz/openbmc_project/PLDM/Requester.interface.yaml b/yaml/xyz/openbmc_project/PLDM/Requester.interface.yaml
index 4de0cd7..2585c82 100644
--- a/yaml/xyz/openbmc_project/PLDM/Requester.interface.yaml
+++ b/yaml/xyz/openbmc_project/PLDM/Requester.interface.yaml
@@ -37,15 +37,15 @@
post this interval, the way of handling the same (further retries,
report an error, etc) is left to the user.
parameters:
- - name: eid
- type: byte
- description: >
- The MCTP endpoint, specified by 'eid' (endpoint id), for which the
- new PLDM instance id needs to be generated.
+ - name: eid
+ type: byte
+ description: >
+ The MCTP endpoint, specified by 'eid' (endpoint id), for which the
+ new PLDM instance id needs to be generated.
returns:
- - name: instanceid
- type: byte
- description: >
- PLDM instance id.
+ - name: instanceid
+ type: byte
+ description: >
+ PLDM instance id.
errors:
- - xyz.openbmc_project.Common.Error.TooManyResources
+ - xyz.openbmc_project.Common.Error.TooManyResources
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
index a6dca82..dfd65b7 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
@@ -51,31 +51,31 @@
description: >
The high threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: CriticalHighAlarmDeasserted
description: >
The high threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: CriticalLowAlarmAsserted
description: >
The low threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: CriticalLowAlarmDeasserted
description: >
The low threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
index 0ac56f4..dc8d855 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
@@ -54,31 +54,31 @@
description: >
The high threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: HardShutdownHighAlarmDeasserted
description: >
The high threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: HardShutdownLowAlarmAsserted
description: >
The low threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: HardShutdownLowAlarmDeasserted
description: >
The low threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
index ec1777b..8303572 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
@@ -54,31 +54,31 @@
description: >
The high threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: PerformanceLossHighAlarmDeasserted
description: >
The high threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: PerformanceLossLowAlarmAsserted
description: >
The low threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: PerformanceLossLowAlarmDeasserted
description: >
The low threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
index daf7078..ba175f6 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
@@ -53,31 +53,31 @@
description: >
The high threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: SoftShutdownHighAlarmDeasserted
description: >
The high threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: SoftShutdownLowAlarmAsserted
description: >
The low threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: SoftShutdownLowAlarmDeasserted
description: >
The low threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
index 3226862..a141da5 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
@@ -51,31 +51,31 @@
description: >
The high threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: WarningHighAlarmDeasserted
description: >
The high threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: WarningLowAlarmAsserted
description: >
The low threshold alarm asserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
- name: WarningLowAlarmDeasserted
description: >
The low threshold alarm deasserted.
properties:
- - name: SensorValue
- type: double
- description: >
- The sensor value that triggered the alarm change.
+ - name: SensorValue
+ type: double
+ description: >
+ The sensor value that triggered the alarm change.
diff --git a/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml
index 2af3f67..bf51eff 100644
--- a/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml
@@ -54,38 +54,38 @@
enumerations:
- name: Unit
description: >
- A sensor reading unit.
+ A sensor reading unit.
values:
- - name: Amperes
- description: >
- Electrical charge flow rate as Amperes.
- - name: CFM
- description: >
- To calculate Air Flow in Cubic Feet per Minute
- - name: DegreesC
- description: >
- Temperature as degrees Celsius.
- - name: Joules
- description: >
- Energy transfer as Joules.
- - name: Meters
- description: >
- Length as meters.
- - name: Percent
- description: >
- Resource utilization as a percentage.
- - name: PercentRH
- description: >
- Relative humidity as a percentage.
- - name: Pascals
- description: >
- Pressure as pascals.
- - name: RPMS
- description: >
- Frequency of rotation as revolutions per minute.
- - name: Volts
- description: >
- Electomotive force as volts.
- - name: Watts
- description: >
- Rate of energy transfer as Watts.
+ - name: Amperes
+ description: >
+ Electrical charge flow rate as Amperes.
+ - name: CFM
+ description: >
+ To calculate Air Flow in Cubic Feet per Minute
+ - name: DegreesC
+ description: >
+ Temperature as degrees Celsius.
+ - name: Joules
+ description: >
+ Energy transfer as Joules.
+ - name: Meters
+ description: >
+ Length as meters.
+ - name: Percent
+ description: >
+ Resource utilization as a percentage.
+ - name: PercentRH
+ description: >
+ Relative humidity as a percentage.
+ - name: Pascals
+ description: >
+ Pressure as pascals.
+ - name: RPMS
+ description: >
+ Frequency of rotation as revolutions per minute.
+ - name: Volts
+ description: >
+ Electomotive force as volts.
+ - name: Watts
+ description: >
+ Rate of energy transfer as Watts.
diff --git a/yaml/xyz/openbmc_project/Smbios/MDR_V2.interface.yaml b/yaml/xyz/openbmc_project/Smbios/MDR_V2.interface.yaml
index 987e0ee..4582ac2 100644
--- a/yaml/xyz/openbmc_project/Smbios/MDR_V2.interface.yaml
+++ b/yaml/xyz/openbmc_project/Smbios/MDR_V2.interface.yaml
@@ -5,154 +5,154 @@
description: >
Get the directory with directory index.
parameters:
- - name: dirIndex
- type: byte
- description: >
- Directory index of SMBIOS.
+ - name: dirIndex
+ type: byte
+ description: >
+ Directory index of SMBIOS.
returns:
- - name: dir
- type: array[byte]
- description: >
- Directory of agent.
+ - name: dir
+ type: array[byte]
+ description: >
+ Directory of agent.
errors:
- - self.Error.InvalidParameter
+ - self.Error.InvalidParameter
- name: GetDataInformation
description: >
Get the data info with id index and data set ID.
parameters:
- - name: idIndex
- type: byte
- description: >
- Index of SMBIOS directory.
+ - name: idIndex
+ type: byte
+ description: >
+ Index of SMBIOS directory.
returns:
- - name: dataInfo
- type: array[byte]
- description: >
- Data information of SMBIOS.
+ - name: dataInfo
+ type: array[byte]
+ description: >
+ Data information of SMBIOS.
errors:
- - self.Error.InvalidParameter
+ - self.Error.InvalidParameter
- name: SendDirectoryInformation
description: >
- Send directory information to SMBIOS directory.
+ Send directory information to SMBIOS directory.
parameters:
- - name: dirVersion
- type: byte
- description: >
- A counter which increments each time directory updated.
- - name: dirIndex
- type: byte
- description: >
- Directory index of SMBIOS.
- - name: returnedEntries
- type: byte
- description: >
- Indicates number of directory entries.
- - name: remainingEntries
- type: byte
- description: >
- Remaining entries which are higher than index in this transfer.
- - name: dirEntry
- type: array[byte]
- description: >
- Data set ID of SMBIOS table.
+ - name: dirVersion
+ type: byte
+ description: >
+ A counter which increments each time directory updated.
+ - name: dirIndex
+ type: byte
+ description: >
+ Directory index of SMBIOS.
+ - name: returnedEntries
+ type: byte
+ description: >
+ Indicates number of directory entries.
+ - name: remainingEntries
+ type: byte
+ description: >
+ Remaining entries which are higher than index in this transfer.
+ - name: dirEntry
+ type: array[byte]
+ description: >
+ Data set ID of SMBIOS table.
returns:
- - name: status
- type: boolean
- description: >
- Need to continue directory transmisson or not.
+ - name: status
+ type: boolean
+ description: >
+ Need to continue directory transmisson or not.
errors:
- - self.Error.InvalidParameter
+ - self.Error.InvalidParameter
- name: GetDataOffer
description: >
- Get data set ID.
+ Get data set ID.
returns:
- - name: offer
- type: array[byte]
- description: >
- Data set ID.
+ - name: offer
+ type: array[byte]
+ description: >
+ Data set ID.
errors:
- - self.Error.UpdateInProgress
+ - self.Error.UpdateInProgress
- name: SendDataInformation
description: >
- Send data information with directory index.
+ Send data information with directory index.
parameters:
- - name: idIndex
- type: byte
- description: >
- Index of SMBIOS directory.
- - name: flag
- type: byte
- description: >
- Valid flag to set dir entry status.
- - name: dataLen
- type: uint32
- description: >
- The length of the data in bytes.
- - name: dataVer
- type: uint32
- description: >
- The version number of this data.
- - name: timeStamp
- type: uint32
- description: >
- Timestamp determinded by the agent.
+ - name: idIndex
+ type: byte
+ description: >
+ Index of SMBIOS directory.
+ - name: flag
+ type: byte
+ description: >
+ Valid flag to set dir entry status.
+ - name: dataLen
+ type: uint32
+ description: >
+ The length of the data in bytes.
+ - name: dataVer
+ type: uint32
+ description: >
+ The version number of this data.
+ - name: timeStamp
+ type: uint32
+ description: >
+ Timestamp determinded by the agent.
returns:
- - name: status
- type: boolean
- description: >
- Whether data changes.
+ - name: status
+ type: boolean
+ description: >
+ Whether data changes.
errors:
- - self.Error.InvalidParameter
+ - self.Error.InvalidParameter
- name: FindIdIndex
description: >
Find id index by data info.
parameters:
- - name: dataInfo
- type: array[byte]
- description: >
- Data info of data entry.
+ - name: dataInfo
+ type: array[byte]
+ description: >
+ Data info of data entry.
returns:
- - name: idIndex
- type: int32
- description: >
- Id index of data entry.
+ - name: idIndex
+ type: int32
+ description: >
+ Id index of data entry.
errors:
- - self.Error.InvalidId
+ - self.Error.InvalidId
- name: AgentSynchronizeData
description: >
Synchronize SMBIOS data from file.
returns:
- - name: status
- type: boolean
- description: >
- Whether synchronization succeed or not.
+ - name: status
+ type: boolean
+ description: >
+ Whether synchronization succeed or not.
- name: SynchronizeDirectoryCommonData
description: >
Synchronize directory common data.
parameters:
- - name: idIndex
- type: byte
- description: >
- Index of SMBIOS directory.
- - name: size
- type: uint32
- description: >
- Size of data that BIOS prepare to transfer.
+ - name: idIndex
+ type: byte
+ description: >
+ Index of SMBIOS directory.
+ - name: size
+ type: uint32
+ description: >
+ Size of data that BIOS prepare to transfer.
returns:
- - name: commonData
- type: array[uint32]
- description: >
- Directory common data includes data size, version and timestamp.
+ - name: commonData
+ type: array[uint32]
+ description: >
+ Directory common data includes data size, version and timestamp.
properties:
- name: DirectoryEntries
type: byte
description: >
- Numbers of directory entries.
+ Numbers of directory entries.
diff --git a/yaml/xyz/openbmc_project/Software/Activation.interface.yaml b/yaml/xyz/openbmc_project/Software/Activation.interface.yaml
index 6af2984..7153c41 100644
--- a/yaml/xyz/openbmc_project/Software/Activation.interface.yaml
+++ b/yaml/xyz/openbmc_project/Software/Activation.interface.yaml
@@ -4,54 +4,55 @@
- name: Activation
type: enum[self.Activations]
description: >
- The current Activation state of the Software.Version.
+ The current Activation state of the Software.Version.
- name: RequestedActivation
type: enum[self.RequestedActivations]
description: >
- The desired Activation state of the Software.Version.
+ The desired Activation state of the Software.Version.
enumerations:
- name: Activations
description: >
- The possible Activation states of the Software.Version.
+ The possible Activation states of the Software.Version.
values:
- - name: NotReady
- description: >
- The system is still analyzing the Software.Version and is
- currently unable to activate.
- - name: Invalid
- description: >
- The Software.Version is invalid and unable to be activated.
- - name: Ready
- description: >
- The Software.Version has been processed and is ready for
- Activation.
- - name: Activating
- description: >
- The Software.Version is in the process of being Activated.
- - name: Active
- description: >
- The Software.Version is currently Active.
- - name: Failed
- description: >
- The Software.Version failed during or after Activation.
- - name: Staged
- description: >
- The Software.Version is currently in staged flash area.
- This is moved from staged flash area to active upon reset.
- - name: Staging
- description: >
- The Software.Version is currently being staged into the
- staging flash area.
+ - name: NotReady
+ description: >
+ The system is still analyzing the Software.Version and is
+ currently unable to activate.
+ - name: Invalid
+ description: >
+ The Software.Version is invalid and unable to be activated.
+ - name: Ready
+ description: >
+ The Software.Version has been processed and is ready for
+ Activation.
+ - name: Activating
+ description: >
+ The Software.Version is in the process of being Activated.
+ - name: Active
+ description: >
+ The Software.Version is currently Active.
+ - name: Failed
+ description: >
+ The Software.Version failed during or after Activation.
+ - name: Staged
+ description: >
+ The Software.Version is currently in staged flash area.
+ This is moved from staged flash area to active upon reset.
+ - name: Staging
+ description: >
+ The Software.Version is currently being staged into the
+ staging flash area.
- name: RequestedActivations
description: >
- The possible RequestedActivation states of a Software.Version.
+ The possible RequestedActivation states of a Software.Version.
values:
- - name: None
- description: >
- No action has been directed for this Software.Version.
- - name: Active
- description: >
- The Software.Version has been requested for Activation.
+ - name: None
+ description: >
+ No action has been directed for this Software.Version.
+ - name: Active
+ description: >
+ The Software.Version has been requested for Activation.
+
# TODO: Specify "EAGAIN" type error when requested is unable to be acted on
# due to current system state. Currently, sdbusplus does not support
# errors on properties.
diff --git a/yaml/xyz/openbmc_project/Software/ActivationProgress.interface.yaml b/yaml/xyz/openbmc_project/Software/ActivationProgress.interface.yaml
index edb01d8..d22df72 100644
--- a/yaml/xyz/openbmc_project/Software/ActivationProgress.interface.yaml
+++ b/yaml/xyz/openbmc_project/Software/ActivationProgress.interface.yaml
@@ -5,5 +5,5 @@
- name: Progress
type: byte
description: >
- An integer between 0 and 100 representing the percentage complete of
- the current step in software update.
+ An integer between 0 and 100 representing the percentage complete of
+ the current step in software update.
diff --git a/yaml/xyz/openbmc_project/Software/ApplyOptions.interface.yaml b/yaml/xyz/openbmc_project/Software/ApplyOptions.interface.yaml
index 96fe78f..715af7c 100644
--- a/yaml/xyz/openbmc_project/Software/ApplyOptions.interface.yaml
+++ b/yaml/xyz/openbmc_project/Software/ApplyOptions.interface.yaml
@@ -11,7 +11,7 @@
type: boolean
default: false
description: >
- This property indicates whether to clear the software configurations
- when the firmware image update is getting applied. A value of true
- indicates the firmware configurations should be cleared along with
- firmware image activation.
+ This property indicates whether to clear the software configurations
+ when the firmware image update is getting applied. A value of true
+ indicates the firmware configurations should be cleared along with
+ firmware image activation.
diff --git a/yaml/xyz/openbmc_project/Software/ApplyTime.interface.yaml b/yaml/xyz/openbmc_project/Software/ApplyTime.interface.yaml
index 0fff06a..6cdedcf 100644
--- a/yaml/xyz/openbmc_project/Software/ApplyTime.interface.yaml
+++ b/yaml/xyz/openbmc_project/Software/ApplyTime.interface.yaml
@@ -6,17 +6,17 @@
- name: RequestedApplyTime
type: enum[self.RequestedApplyTimes]
description: >
- This property indicates when the software image update should be
- applied.
+ This property indicates when the software image update should be
+ applied.
enumerations:
- name: RequestedApplyTimes
description: >
- The possible values of this property indicate when the newly
- updated software image will be activated.
+ The possible values of this property indicate when the newly
+ updated software image will be activated.
values:
- - name: Immediate
- description: >
- Apply immediately.
- - name: OnReset
- description: >
- Apply on a reset.
+ - name: Immediate
+ description: >
+ Apply immediately.
+ - name: OnReset
+ description: >
+ Apply on a reset.
diff --git a/yaml/xyz/openbmc_project/Software/ExtendedVersion.interface.yaml b/yaml/xyz/openbmc_project/Software/ExtendedVersion.interface.yaml
index 0bcc419..513bc2e 100644
--- a/yaml/xyz/openbmc_project/Software/ExtendedVersion.interface.yaml
+++ b/yaml/xyz/openbmc_project/Software/ExtendedVersion.interface.yaml
@@ -4,4 +4,4 @@
- name: ExtendedVersion
type: string
description: >
- Extended version of the level.
+ Extended version of the level.
diff --git a/yaml/xyz/openbmc_project/Software/RedundancyPriority.interface.yaml b/yaml/xyz/openbmc_project/Software/RedundancyPriority.interface.yaml
index 5290218..4b3e088 100644
--- a/yaml/xyz/openbmc_project/Software/RedundancyPriority.interface.yaml
+++ b/yaml/xyz/openbmc_project/Software/RedundancyPriority.interface.yaml
@@ -5,19 +5,20 @@
- name: Priority
type: byte
description: >
- The priority order specified for the associated Software.Version,
- represented as a value between 0 (High) and 127 (Low). Any value
- above 127 has implementation-specific purpose.
+ The priority order specified for the associated Software.Version,
+ represented as a value between 0 (High) and 127 (Low). Any value
+ above 127 has implementation-specific purpose.
- Only one Software.Version, per associated device, may be at any
- particular priority. A requested priority change may cause other
- Software.Versions to change priority.
+ Only one Software.Version, per associated device, may be at any
+ particular priority. A requested priority change may cause other
+ Software.Versions to change priority.
- A dual-sided redundancy model could be represented by two
- Software.Version associations, one of which is at priority 0 and the
- other at priority 1. When a new image is Activated, the old
- priority-1 association is deleted, the old priority-0 association
- becomes priority-1, and the new image is assigned priority-0.
+ A dual-sided redundancy model could be represented by two
+ Software.Version associations, one of which is at priority 0 and the
+ other at priority 1. When a new image is Activated, the old
+ priority-1 association is deleted, the old priority-0 association
+ becomes priority-1, and the new image is assigned priority-0.
+
# TODO: Specify "EAGAIN" type error when priority is unable to be modified
# due to current system state. Currently, sdbusplus does not support
# errors on properties.
diff --git a/yaml/xyz/openbmc_project/Software/Version.interface.yaml b/yaml/xyz/openbmc_project/Software/Version.interface.yaml
index 22a90ce..6176010 100644
--- a/yaml/xyz/openbmc_project/Software/Version.interface.yaml
+++ b/yaml/xyz/openbmc_project/Software/Version.interface.yaml
@@ -9,35 +9,35 @@
- name: Version
type: string
description: >
- The version identifier.
+ The version identifier.
- name: Purpose
type: enum[self.VersionPurpose]
description: >
- The purpose of the version. As in, what can it be used for or
- applied to?
+ The purpose of the version. As in, what can it be used for or
+ applied to?
- This property is deprecated in favor of Compatible strings and inventory
- associations. The enumeration should not be expanded further.
+ This property is deprecated in favor of Compatible strings and inventory
+ associations. The enumeration should not be expanded further.
enumerations:
- name: VersionPurpose
description: >
- An enumeration of possible purposes of the version.
+ An enumeration of possible purposes of the version.
values:
- - name: Unknown
- description: >
- The version is of unknown purpose.
- - name: Other
- description: >
- The version is of some other purpose.
- - name: System
- description: >
- The version is an aggregate for the system as a whole.
- - name: BMC
- description: >
- The version is a version for the BMC.
- - name: Host
- description: >
- The version is a version for a managed host.
- - name: PSU
- description: >
- The version is a version for a PSU.
+ - name: Unknown
+ description: >
+ The version is of unknown purpose.
+ - name: Other
+ description: >
+ The version is of some other purpose.
+ - name: System
+ description: >
+ The version is an aggregate for the system as a whole.
+ - name: BMC
+ description: >
+ The version is a version for the BMC.
+ - name: Host
+ description: >
+ The version is a version for a managed host.
+ - name: PSU
+ description: >
+ The version is a version for a PSU.
diff --git a/yaml/xyz/openbmc_project/State/BMC.interface.yaml b/yaml/xyz/openbmc_project/State/BMC.interface.yaml
index 62d55e2..03186c5 100644
--- a/yaml/xyz/openbmc_project/State/BMC.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/BMC.interface.yaml
@@ -1,83 +1,83 @@
description: >
- Implementation of BMC state management. When rebooting we are in
- transition. When Ready all services required are running
- successfully. When we are Not Ready this implies not all services
- have started that are required to be.
+ Implementation of BMC state management. When rebooting we are in
+ transition. When Ready all services required are running
+ successfully. When we are Not Ready this implies not all services
+ have started that are required to be.
properties:
- - name: RequestedBMCTransition
- type: enum[self.Transition]
- default: 'None'
- description: >
- The desired BMC transition
+ - name: RequestedBMCTransition
+ type: enum[self.Transition]
+ default: "None"
+ description: >
+ The desired BMC transition
- - name: CurrentBMCState
- type: enum[self.BMCState]
- description: >
- The current state of the BMC and is a read-only property.
+ - name: CurrentBMCState
+ type: enum[self.BMCState]
+ description: >
+ The current state of the BMC and is a read-only property.
- - name: LastRebootTime
- type: uint64
- description: >
- The last time at which the BMC came out of a reboot as
- determined by its uptime, in epoch time, in milliseconds.
+ - name: LastRebootTime
+ type: uint64
+ description: >
+ The last time at which the BMC came out of a reboot as
+ determined by its uptime, in epoch time, in milliseconds.
- - name: LastRebootCause
- type: enum[self.RebootCause]
- default: 'Unknown'
- description: >
- The last BMC reboot cause
+ - name: LastRebootCause
+ type: enum[self.RebootCause]
+ default: "Unknown"
+ description: >
+ The last BMC reboot cause
enumerations:
- - name: Transition
- description: >
- The desired transition for the BMC firmware
- values:
- - name: 'Reboot'
- description: >
- BMC system should be rebooted
- - name: 'HardReboot'
- description: >
- BMC system should be non-gracefully rebooted.
- - name: 'None'
- description: >
- No transition is in progress
+ - name: Transition
+ description: >
+ The desired transition for the BMC firmware
+ values:
+ - name: "Reboot"
+ description: >
+ BMC system should be rebooted
+ - name: "HardReboot"
+ description: >
+ BMC system should be non-gracefully rebooted.
+ - name: "None"
+ description: >
+ No transition is in progress
- - name: BMCState
- description: >
- The current state of the BMC firmware
- values:
- - name: 'Ready'
- description: >
- Ready implies all services started and are running successfully
- - name: 'NotReady'
- description: >
- Not ready implies not all services have started or are not running successfully
- - name: 'UpdateInProgress'
- description: >
- UpdateInProgress implies BMC is in firmware update mode. CurrentBMCState
- will be set to "UpdateInProgress" while starting image download and
- reset to Ready, once activation is done or error case during update process.
- - name: 'Quiesced'
- description: >
- BMC firmware is quiesced. The BMC firmware is enabled but either
- unresponsive or only processing a restricted set of commands. This
- state may be the result of a service within the BMC going into a
- failed state.
+ - name: BMCState
+ description: >
+ The current state of the BMC firmware
+ values:
+ - name: "Ready"
+ description: >
+ Ready implies all services started and are running successfully
+ - name: "NotReady"
+ description: >
+ Not ready implies not all services have started or are not running successfully
+ - name: "UpdateInProgress"
+ description: >
+ UpdateInProgress implies BMC is in firmware update mode. CurrentBMCState
+ will be set to "UpdateInProgress" while starting image download and
+ reset to Ready, once activation is done or error case during update process.
+ - name: "Quiesced"
+ description: >
+ BMC firmware is quiesced. The BMC firmware is enabled but either
+ unresponsive or only processing a restricted set of commands. This
+ state may be the result of a service within the BMC going into a
+ failed state.
- - name: RebootCause
- description: >
- The recorded reboot cause of the BMC
- values:
- - name: 'POR'
- description: >
- Last reboot is caused by Power-On-Reset
- - name: 'PinholeReset'
- description: >
- Last reboot is caused by pinhole reset
- - name: 'Watchdog'
- description: >
- Last reboot is caused by Watchdog
- - name: 'Unknown'
- description: >
- Last reboot is caused by Unknown
+ - name: RebootCause
+ description: >
+ The recorded reboot cause of the BMC
+ values:
+ - name: "POR"
+ description: >
+ Last reboot is caused by Power-On-Reset
+ - name: "PinholeReset"
+ description: >
+ Last reboot is caused by pinhole reset
+ - name: "Watchdog"
+ description: >
+ Last reboot is caused by Watchdog
+ - name: "Unknown"
+ description: >
+ Last reboot is caused by Unknown
diff --git a/yaml/xyz/openbmc_project/State/Boot/PostCode.interface.yaml b/yaml/xyz/openbmc_project/State/Boot/PostCode.interface.yaml
index 0dea5c7..d72ef2b 100644
--- a/yaml/xyz/openbmc_project/State/Boot/PostCode.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Boot/PostCode.interface.yaml
@@ -20,29 +20,29 @@
description: >
Method to get the cached post codes of the indicated boot cycle with timestamp.
parameters:
- - name: Index
- type: uint16
- description: >
- Index indicates which boot cycle of post codes is requested.
- 1 is for the most recent boot cycle. CurrentBootCycleCount is for the
- oldest boot cycle.
+ - name: Index
+ type: uint16
+ description: >
+ Index indicates which boot cycle of post codes is requested.
+ 1 is for the most recent boot cycle. CurrentBootCycleCount is for the
+ oldest boot cycle.
returns:
- - name: Codes
- type: dict[uint64, struct[uint64,array[byte]]]
- description: >
- An array of post codes and timestamp in microseconds since epoch
+ - name: Codes
+ type: dict[uint64, struct[uint64,array[byte]]]
+ description: >
+ An array of post codes and timestamp in microseconds since epoch
- name: GetPostCodes
description: >
Method to get the cached post codes of the indicated boot cycle.
parameters:
- - name: Index
- type: uint16
- description: >
- Index indicates which boot cycle of post codes is requested.
- 1 is for the most recent boot cycle. CurrentBootCycleCount is for the
- oldest boot cycle.
+ - name: Index
+ type: uint16
+ description: >
+ Index indicates which boot cycle of post codes is requested.
+ 1 is for the most recent boot cycle. CurrentBootCycleCount is for the
+ oldest boot cycle.
returns:
- - name: Codes
- type: array[struct[uint64,array[byte]]]
- description: >
- An array of post codes of one boot cycle.
+ - name: Codes
+ type: array[struct[uint64,array[byte]]]
+ description: >
+ An array of post codes of one boot cycle.
diff --git a/yaml/xyz/openbmc_project/State/Boot/Progress.interface.yaml b/yaml/xyz/openbmc_project/State/Boot/Progress.interface.yaml
index 45699b1..07f2d82 100644
--- a/yaml/xyz/openbmc_project/State/Boot/Progress.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Boot/Progress.interface.yaml
@@ -6,7 +6,7 @@
type: enum[self.ProgressStages]
default: Unspecified
description: >
- Current boot progress
+ Current boot progress
- name: BootProgressLastUpdate
type: uint64
@@ -19,40 +19,40 @@
to know how long the boot has been on the current boot step.
enumerations:
- - name: ProgressStages
- description: >
- The boot progress stage
- values:
- - name: Unspecified
- description: >
- Unknown state.
- - name: PrimaryProcInit
- description: >
- Primary Processor Initialization
- - name: BusInit
- description: >
- Processor and Memory Bus Initialization
- - name: MemoryInit
- description: >
- Memory Initialization
- - name: SecondaryProcInit
- description: >
- Secondary Processor Initialization
- - name: PCIInit
- description: >
- PCI resource initialization
- - name: SystemInitComplete
- description: >
- System firmware completed booting
- - name: OSStart
- description: >
- Starting Operating System.
- - name: OSRunning
- description: >
- Operating System up and running
- - name: SystemSetup
- description: >
- System firmware has entered a setup state
- - name: MotherboardInit
- description: >
- Motherboard/Basebord Initialization.
+ - name: ProgressStages
+ description: >
+ The boot progress stage
+ values:
+ - name: Unspecified
+ description: >
+ Unknown state.
+ - name: PrimaryProcInit
+ description: >
+ Primary Processor Initialization
+ - name: BusInit
+ description: >
+ Processor and Memory Bus Initialization
+ - name: MemoryInit
+ description: >
+ Memory Initialization
+ - name: SecondaryProcInit
+ description: >
+ Secondary Processor Initialization
+ - name: PCIInit
+ description: >
+ PCI resource initialization
+ - name: SystemInitComplete
+ description: >
+ System firmware completed booting
+ - name: OSStart
+ description: >
+ Starting Operating System.
+ - name: OSRunning
+ description: >
+ Operating System up and running
+ - name: SystemSetup
+ description: >
+ System firmware has entered a setup state
+ - name: MotherboardInit
+ description: >
+ Motherboard/Basebord Initialization.
diff --git a/yaml/xyz/openbmc_project/State/Boot/Raw.interface.yaml b/yaml/xyz/openbmc_project/State/Boot/Raw.interface.yaml
index 7e9d435..b288cb0 100644
--- a/yaml/xyz/openbmc_project/State/Boot/Raw.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Boot/Raw.interface.yaml
@@ -6,4 +6,3 @@
type: struct[uint64,array[byte]]
description: >
The POST code value.
-
diff --git a/yaml/xyz/openbmc_project/State/Chassis.interface.yaml b/yaml/xyz/openbmc_project/State/Chassis.interface.yaml
index 1fc8fe3..0d1fb45 100644
--- a/yaml/xyz/openbmc_project/State/Chassis.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Chassis.interface.yaml
@@ -1,10 +1,9 @@
-description:
- Implement to provide the chassis power management
+description: Implement to provide the chassis power management
properties:
- name: RequestedPowerTransition
type: enum[self.Transition]
- default: 'Off'
+ default: "Off"
description: >
The desired power transition to start on this chassis.
This will be preserved across AC power cycles of the BMC.
@@ -36,55 +35,55 @@
enumerations:
- name: Transition
description: >
- The desired power transition for the chassis
+ The desired power transition for the chassis
values:
- - name: 'Off'
- description: >
- Chassis power should be off
- - name: 'On'
- description: >
- Chassis power should be on
- - name: 'PowerCycle'
- description: >
- Chassis power should be cycled from off to on. There will be a 5
- second delay between the off and the on.
+ - name: "Off"
+ description: >
+ Chassis power should be off
+ - name: "On"
+ description: >
+ Chassis power should be on
+ - name: "PowerCycle"
+ description: >
+ Chassis power should be cycled from off to on. There will be a 5
+ second delay between the off and the on.
- name: PowerState
description: >
- The current state of the chassis power
+ The current state of the chassis power
values:
- - name: 'Off'
- description: >
- Chassis power is off
- - name: 'TransitioningToOff'
- description: >
- Firmware is transitioning the chassis to an Off state
- - name: 'On'
- description: >
- Chassis power is on
- - name: 'TransitioningToOn'
- description: >
- Firmware is transitioning the chassis to an On state
+ - name: "Off"
+ description: >
+ Chassis power is off
+ - name: "TransitioningToOff"
+ description: >
+ Firmware is transitioning the chassis to an Off state
+ - name: "On"
+ description: >
+ Chassis power is on
+ - name: "TransitioningToOn"
+ description: >
+ Firmware is transitioning the chassis to an On state
- name: PowerStatus
description: >
- The current status of the chassis power
+ The current status of the chassis power
values:
- - name: 'Undefined'
- description: >
- Chassis power status is unknown
- - name: 'BrownOut'
- description: >
- Chassis power status is in a brownout condition.
- - name: 'UninterruptiblePowerSupply'
- description: >
- Chassis power is being provided via an uninterruptible power
- supply. Note that some systems may choose to continue to use this
- status, even once power has returned to the system, to indicate the
- uninterruptible power supply is charging or is below a certain
- threshold of charged. This provides system owners the flexibility on
- whether their system requires a certain level of charged
- uninterruptible power supply to be in a 'Good' state or not.
- - name: 'Good'
- description: >
- Chassis power status is in a good condition
+ - name: "Undefined"
+ description: >
+ Chassis power status is unknown
+ - name: "BrownOut"
+ description: >
+ Chassis power status is in a brownout condition.
+ - name: "UninterruptiblePowerSupply"
+ description: >
+ Chassis power is being provided via an uninterruptible power
+ supply. Note that some systems may choose to continue to use this
+ status, even once power has returned to the system, to indicate the
+ uninterruptible power supply is charging or is below a certain
+ threshold of charged. This provides system owners the flexibility on
+ whether their system requires a certain level of charged
+ uninterruptible power supply to be in a 'Good' state or not.
+ - name: "Good"
+ description: >
+ Chassis power status is in a good condition
diff --git a/yaml/xyz/openbmc_project/State/Decorator/Availability.interface.yaml b/yaml/xyz/openbmc_project/State/Decorator/Availability.interface.yaml
index 2db2c17..75f6bcc 100644
--- a/yaml/xyz/openbmc_project/State/Decorator/Availability.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Decorator/Availability.interface.yaml
@@ -4,5 +4,5 @@
- name: Available
type: boolean
description: >
- True if the object can be accessed.
+ True if the object can be accessed.
default: true
diff --git a/yaml/xyz/openbmc_project/State/Decorator/OperationalStatus.interface.yaml b/yaml/xyz/openbmc_project/State/Decorator/OperationalStatus.interface.yaml
index 45ff54e..5667f22 100644
--- a/yaml/xyz/openbmc_project/State/Decorator/OperationalStatus.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Decorator/OperationalStatus.interface.yaml
@@ -4,5 +4,5 @@
- name: Functional
type: boolean
description: >
- The object is functional or not.
- default: false
\ No newline at end of file
+ The object is functional or not.
+ default: false
diff --git a/yaml/xyz/openbmc_project/State/Decorator/PowerState.interface.yaml b/yaml/xyz/openbmc_project/State/Decorator/PowerState.interface.yaml
index 06aa56f..ede4bc7 100644
--- a/yaml/xyz/openbmc_project/State/Decorator/PowerState.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Decorator/PowerState.interface.yaml
@@ -5,25 +5,25 @@
type: enum[self.State]
default: Unknown
description: >
- The current power status of the object.
+ The current power status of the object.
enumerations:
- - name: State
- description: >
- Power state enum.
- values:
- - name: "On"
- description: >
- The state of the object is powered on.
- - name: "Off"
- description: >
- The state of the object is powered off.
- - name: PoweringOn
- description: >
- The object is in a temporary state between off and on.
- - name: PoweringOff
- description: >
- The object is in a temporary state between on and off.
- - name: Unknown
- description: >
- The power state is unknown.
+ - name: State
+ description: >
+ Power state enum.
+ values:
+ - name: "On"
+ description: >
+ The state of the object is powered on.
+ - name: "Off"
+ description: >
+ The state of the object is powered off.
+ - name: PoweringOn
+ description: >
+ The object is in a temporary state between off and on.
+ - name: PoweringOff
+ description: >
+ The object is in a temporary state between on and off.
+ - name: Unknown
+ description: >
+ The power state is unknown.
diff --git a/yaml/xyz/openbmc_project/State/Host.interface.yaml b/yaml/xyz/openbmc_project/State/Host.interface.yaml
index 3eeafe9..02deb2d 100644
--- a/yaml/xyz/openbmc_project/State/Host.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Host.interface.yaml
@@ -4,7 +4,7 @@
properties:
- name: RequestedHostTransition
type: enum[self.Transition]
- default: 'Off'
+ default: "Off"
description: >
The desired host transition. This will be preserved across AC
power cycles of the BMC.
@@ -19,104 +19,104 @@
- name: RestartCause
type: enum[self.RestartCause]
- default: 'Unknown'
+ default: "Unknown"
description: >
A property to define restart cause of a host.
enumerations:
- name: Transition
description: >
- The desired transition for host firmware
+ The desired transition for host firmware
values:
- - name: 'Off'
- description: >
- Host firmware should be off
- - name: 'On'
- description: >
- Host firmware should be on
- - name: 'Reboot'
- description: >
- Host firmware should be rebooted. Chassis power will be cycled from
- off to on during this reboot
- - name: 'GracefulWarmReboot'
- description: >
- Host firmware be will notified to shutdown and once complete, the
- host firmware will be rebooted. Chassis power will remain on
- throughout the reboot
- - name: 'ForceWarmReboot'
- description: >
- Host firmware will be rebooted without notification and chassis
- power will remain on throughout the reboot
+ - name: "Off"
+ description: >
+ Host firmware should be off
+ - name: "On"
+ description: >
+ Host firmware should be on
+ - name: "Reboot"
+ description: >
+ Host firmware should be rebooted. Chassis power will be cycled from
+ off to on during this reboot
+ - name: "GracefulWarmReboot"
+ description: >
+ Host firmware be will notified to shutdown and once complete, the
+ host firmware will be rebooted. Chassis power will remain on
+ throughout the reboot
+ - name: "ForceWarmReboot"
+ description: >
+ Host firmware will be rebooted without notification and chassis
+ power will remain on throughout the reboot
- name: HostState
description: >
- The current state of the host firmware
+ The current state of the host firmware
values:
- - name: 'Off'
- description: >
- Host firmware is not running
- - name: 'TransitioningToOff'
- description: >
- Host firmware is transitioning to an Off state
- - name: 'Standby'
- description: >
- Host firmware is in a standby state. It is awaiting a Transition
- request to On to move to Running. This is an intermediate state
- that some implementations of this object may move to between Off
- and Running.
- - name: 'Running'
- description: >
- Host firmware is running
- - name: 'TransitioningToRunning'
- description: >
- Host firmware is transitioning to a Running state
- - name: 'Quiesced'
- description: >
- Host firmware is quiesced. The host firmware is enabled but either
- unresponsive or only processing a restricted set of commands. This
- state can be a result of the host entering an error state or booting
- into a BIOS setup environment. The BootProgress property will
- provide details on which it is.
- - name: 'DiagnosticMode'
- description: >
- Host firmware is capturing debug information. Powering off your
- system while the host is in this state will prevent the debug data
- from being properly collected. The host will move to one of the
- other states once complete.
+ - name: "Off"
+ description: >
+ Host firmware is not running
+ - name: "TransitioningToOff"
+ description: >
+ Host firmware is transitioning to an Off state
+ - name: "Standby"
+ description: >
+ Host firmware is in a standby state. It is awaiting a Transition
+ request to On to move to Running. This is an intermediate state
+ that some implementations of this object may move to between Off
+ and Running.
+ - name: "Running"
+ description: >
+ Host firmware is running
+ - name: "TransitioningToRunning"
+ description: >
+ Host firmware is transitioning to a Running state
+ - name: "Quiesced"
+ description: >
+ Host firmware is quiesced. The host firmware is enabled but either
+ unresponsive or only processing a restricted set of commands. This
+ state can be a result of the host entering an error state or booting
+ into a BIOS setup environment. The BootProgress property will
+ provide details on which it is.
+ - name: "DiagnosticMode"
+ description: >
+ Host firmware is capturing debug information. Powering off your
+ system while the host is in this state will prevent the debug data
+ from being properly collected. The host will move to one of the
+ other states once complete.
- name: RestartCause
description: >
- The reason for host restart.
+ The reason for host restart.
values:
- - name: 'Unknown'
- description: >
- Reason Unknown
- - name: 'RemoteCommand'
- description: >
- Remote command issued
- - name: 'ResetButton'
- description: >
- Reset button pressed
- - name: 'PowerButton'
- description: >
- Power button pressed
- - name: 'WatchdogTimer'
- description: >
- Watchdog Timer expired
- - name: 'PowerPolicyAlwaysOn'
- description: >
- Power Policy Host Always on
- - name: 'PowerPolicyPreviousState'
- description: >
- Power Policy Previous State of Host
- - name: 'SoftReset'
- description: >
- Soft reset of Host
- - name: 'ScheduledPowerOn'
- description: >
- The restart was scheduled via the
- xyz.openbmc_project.State.ScheduledHostTransition interface
- - name: 'HostCrash'
- description: >
- The host firmware crashed and the BMC has automatically initiated a
- restart of the host firmware
+ - name: "Unknown"
+ description: >
+ Reason Unknown
+ - name: "RemoteCommand"
+ description: >
+ Remote command issued
+ - name: "ResetButton"
+ description: >
+ Reset button pressed
+ - name: "PowerButton"
+ description: >
+ Power button pressed
+ - name: "WatchdogTimer"
+ description: >
+ Watchdog Timer expired
+ - name: "PowerPolicyAlwaysOn"
+ description: >
+ Power Policy Host Always on
+ - name: "PowerPolicyPreviousState"
+ description: >
+ Power Policy Previous State of Host
+ - name: "SoftReset"
+ description: >
+ Soft reset of Host
+ - name: "ScheduledPowerOn"
+ description: >
+ The restart was scheduled via the
+ xyz.openbmc_project.State.ScheduledHostTransition interface
+ - name: "HostCrash"
+ description: >
+ The host firmware crashed and the BMC has automatically initiated a
+ restart of the host firmware
diff --git a/yaml/xyz/openbmc_project/State/OperatingSystem/Status.interface.yaml b/yaml/xyz/openbmc_project/State/OperatingSystem/Status.interface.yaml
index 4482eb1..705b4bf 100644
--- a/yaml/xyz/openbmc_project/State/OperatingSystem/Status.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/OperatingSystem/Status.interface.yaml
@@ -6,34 +6,34 @@
type: enum[self.OSStatus]
default: Inactive
description: >
- Current state of the operating system.
+ Current state of the operating system.
enumerations:
- - name: OSStatus
- description: >
- The operaing system statuses.
- values:
- - name: CBoot
- description: >
- C Boot Completed.
- - name: PXEBoot
- description: >
- PXE Boot Completed.
- - name: DiagBoot
- description: >
- Diagnostic Boot Completed.
- - name: CDROMBoot
- description: >
- CD-ROM Boot completed.
- - name: ROMBoot
- description: >
- ROM Boot Completed
- - name: BootComplete
- description: >
- Boot Completed or Unspecified Boot Device.
- - name: Inactive
- description: >
- System Inactive.
- - name: Standby
- description: >
- Operating system is ready to be booted.
+ - name: OSStatus
+ description: >
+ The operaing system statuses.
+ values:
+ - name: CBoot
+ description: >
+ C Boot Completed.
+ - name: PXEBoot
+ description: >
+ PXE Boot Completed.
+ - name: DiagBoot
+ description: >
+ Diagnostic Boot Completed.
+ - name: CDROMBoot
+ description: >
+ CD-ROM Boot completed.
+ - name: ROMBoot
+ description: >
+ ROM Boot Completed
+ - name: BootComplete
+ description: >
+ Boot Completed or Unspecified Boot Device.
+ - name: Inactive
+ description: >
+ System Inactive.
+ - name: Standby
+ description: >
+ Operating system is ready to be booted.
diff --git a/yaml/xyz/openbmc_project/State/PowerOnHours.interface.yaml b/yaml/xyz/openbmc_project/State/PowerOnHours.interface.yaml
index 1c68296..660b2ba 100644
--- a/yaml/xyz/openbmc_project/State/PowerOnHours.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/PowerOnHours.interface.yaml
@@ -4,5 +4,5 @@
- name: POHCounter
type: uint32
description: >
- This counter shows how many hours the system has been running. The value
- is a cumulative one and includes all working hours since production.
+ This counter shows how many hours the system has been running. The value
+ is a cumulative one and includes all working hours since production.
diff --git a/yaml/xyz/openbmc_project/State/ScheduledHostTransition.interface.yaml b/yaml/xyz/openbmc_project/State/ScheduledHostTransition.interface.yaml
index 93498ad..74f1fd9 100644
--- a/yaml/xyz/openbmc_project/State/ScheduledHostTransition.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/ScheduledHostTransition.interface.yaml
@@ -25,11 +25,11 @@
to power on/off, e.g. when BMC is rebooting, BMC shall
set the host ScheduledTransition after it is ready.
errors:
- - xyz.openbmc_project.ScheduledTime.Error.InvalidTime
+ - xyz.openbmc_project.ScheduledTime.Error.InvalidTime
- name: ScheduledTransition
type: enum[xyz.openbmc_project.State.Host.Transition]
- default: 'On'
+ default: "On"
description: >
The desired power transition to support scheduled power on/off.
The default operation supports scheduled power on.
diff --git a/yaml/xyz/openbmc_project/State/Watchdog.interface.yaml b/yaml/xyz/openbmc_project/State/Watchdog.interface.yaml
index 8a7335f..ac71e61 100644
--- a/yaml/xyz/openbmc_project/State/Watchdog.interface.yaml
+++ b/yaml/xyz/openbmc_project/State/Watchdog.interface.yaml
@@ -9,13 +9,13 @@
into the TimeRemaining. Optionally the watchdog can be enabled
during the reset process.
parameters:
- - name: EnableWatchdog
- type: boolean
- description: >
- If true the watchdog will be enabled when the reset
- is performed.
+ - name: EnableWatchdog
+ type: boolean
+ description: >
+ If true the watchdog will be enabled when the reset
+ is performed.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
properties:
- name: Initialized
@@ -32,7 +32,7 @@
type: enum[self.Action]
description: >
The action the watchdog should perform when it expires.
- default: 'HardReset'
+ default: "HardReset"
- name: Interval
type: uint64
description: >
@@ -48,60 +48,60 @@
type: enum[self.TimerUse]
description: >
The host defined user of this timer.
- default: 'Reserved'
+ default: "Reserved"
- name: ExpiredTimerUse
type: enum[self.TimerUse]
description: >
The timer user at the time of expiration.
- default: 'Reserved'
+ default: "Reserved"
enumerations:
- - name: Action
- description: >
- The type of action to perform.
- values:
- - name: 'None'
- description: >
- Do nothing.
- - name: 'HardReset'
- description: >
- Perform a reset of the system.
- - name: 'PowerOff'
- description: >
- Perform a power off of the system.
- - name: 'PowerCycle'
- description: >
- Perform a power cycle of the system.
+ - name: Action
+ description: >
+ The type of action to perform.
+ values:
+ - name: "None"
+ description: >
+ Do nothing.
+ - name: "HardReset"
+ description: >
+ Perform a reset of the system.
+ - name: "PowerOff"
+ description: >
+ Perform a power off of the system.
+ - name: "PowerCycle"
+ description: >
+ Perform a power cycle of the system.
- - name: TimerUse
- description: >
- The type of timer use.
- values:
- - name: 'Reserved'
- description: >
- Reserved.
- - name: 'BIOSFRB2'
- description: >
- BIOS FRB2.
- - name: 'BIOSPOST'
- description: >
- BIOS POST.
- - name: 'OSLoad'
- description: >
- OS Load.
- - name: SMSOS
- description: >
- SMS OS.
- - name: 'OEM'
- description: >
- OEM.
+ - name: TimerUse
+ description: >
+ The type of timer use.
+ values:
+ - name: "Reserved"
+ description: >
+ Reserved.
+ - name: "BIOSFRB2"
+ description: >
+ BIOS FRB2.
+ - name: "BIOSPOST"
+ description: >
+ BIOS POST.
+ - name: "OSLoad"
+ description: >
+ OS Load.
+ - name: SMSOS
+ description: >
+ SMS OS.
+ - name: "OEM"
+ description: >
+ OEM.
signals:
- name: Timeout
description: >
- Watchdog timeout event signal
+ Watchdog timeout event signal
properties:
- - name: Action
- type: enum[self.Action]
- description: >
- The action taken during the watchdog timeout event.
+ - name: Action
+ type: enum[self.Action]
+ description: >
+ The action taken during the watchdog timeout event.
diff --git a/yaml/xyz/openbmc_project/Telemetry/Report.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/Report.interface.yaml
index 6d992fc..041f582 100644
--- a/yaml/xyz/openbmc_project/Telemetry/Report.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/Report.interface.yaml
@@ -4,137 +4,137 @@
xyz.openbmc_project.Object.Delete for deletion of individual report objects.
methods:
- - name: Update
- description: >
- The Update method is defined for the on demand metric report update.
- It triggers update of the Readings property. If ReportingType is not
- set to OnRequest then method does nothing.
+ - name: Update
+ description: >
+ The Update method is defined for the on demand metric report update.
+ It triggers update of the Readings property. If ReportingType is not
+ set to OnRequest then method does nothing.
properties:
- - name: Persistency
- type: boolean
- description: >
- Defines if the report configuration is stored in non volatile memory.
- Configuration contains all Report properties excluding Readings.
- - name: ReadingParameters
- type: array[struct[array[object_path],enum[self.OperationType],string,string,enum[self.CollectionTimescope],uint64]]
- description: >
- Array of structures that contains array of sensor paths that are
- monitored by Telemetry service, operation type, metric Id, metadata,
- collection timescope and collection duration. Metric Id and metadata are
- used to store user details, e.g. metadata can be used to map sensor name
- to DBus path.
- - name: Readings
- type: struct[uint64,array[struct[string,string,double,uint64]]]
- description: >
- Structure that contains timestamp of readings update in milliseconds and
- array of metric Id, metadata, reading value and timestamp of single
- reading update in milliseconds. Metric Id and metadata are equal to its
- counterparts in ReadingParameters property.
- flags:
- - readonly
- - name: EmitsReadingsUpdate
- type: boolean
- description: >
- On Readings update PropertiesChanged signal is emitted. It allows to
- decrease generation of load on DBus when Readings property is updated.
- Redfish Event Service requires this option to be equal to true.
- flags:
- - const
- - name: LogToMetricReportsCollection
- type: boolean
- description: >
- Presence of Report in Metric Report Collection in Redfish Telemetry
- Service.
- flags:
- - const
- - name: ReportingType
- type: enum[self.ReportingType]
- description: Defines how readings are updated.
- - name: ReportUpdates
- type: enum[self.ReportUpdates]
- description: Defines how Readings array is filled.
- - name: AppendLimit
- type: size
- description: Defines the maximum number of entries in 'Readings' property.
- flags:
- - readonly
- - name: Interval
- type: uint64
- description: >
- Defines period of time in milliseconds when readings are updated.
- - name: Enabled
- type: boolean
- description: >
- Indicates if readings in report will be updated. This may be set to
- false by the service if ReportUpdates property is 'AppendStopsWhenFull'
- and readings limit specified by AppendLimit is reached.
+ - name: Persistency
+ type: boolean
+ description: >
+ Defines if the report configuration is stored in non volatile memory.
+ Configuration contains all Report properties excluding Readings.
+ - name: ReadingParameters
+ type: array[struct[array[object_path],enum[self.OperationType],string,string,enum[self.CollectionTimescope],uint64]]
+ description: >
+ Array of structures that contains array of sensor paths that are
+ monitored by Telemetry service, operation type, metric Id, metadata,
+ collection timescope and collection duration. Metric Id and metadata are
+ used to store user details, e.g. metadata can be used to map sensor name
+ to DBus path.
+ - name: Readings
+ type: struct[uint64,array[struct[string,string,double,uint64]]]
+ description: >
+ Structure that contains timestamp of readings update in milliseconds and
+ array of metric Id, metadata, reading value and timestamp of single
+ reading update in milliseconds. Metric Id and metadata are equal to its
+ counterparts in ReadingParameters property.
+ flags:
+ - readonly
+ - name: EmitsReadingsUpdate
+ type: boolean
+ description: >
+ On Readings update PropertiesChanged signal is emitted. It allows to
+ decrease generation of load on DBus when Readings property is updated.
+ Redfish Event Service requires this option to be equal to true.
+ flags:
+ - const
+ - name: LogToMetricReportsCollection
+ type: boolean
+ description: >
+ Presence of Report in Metric Report Collection in Redfish Telemetry
+ Service.
+ flags:
+ - const
+ - name: ReportingType
+ type: enum[self.ReportingType]
+ description: Defines how readings are updated.
+ - name: ReportUpdates
+ type: enum[self.ReportUpdates]
+ description: Defines how Readings array is filled.
+ - name: AppendLimit
+ type: size
+ description: Defines the maximum number of entries in 'Readings' property.
+ flags:
+ - readonly
+ - name: Interval
+ type: uint64
+ description: >
+ Defines period of time in milliseconds when readings are updated.
+ - name: Enabled
+ type: boolean
+ description: >
+ Indicates if readings in report will be updated. This may be set to
+ false by the service if ReportUpdates property is 'AppendStopsWhenFull'
+ and readings limit specified by AppendLimit is reached.
enumerations:
- - name: OperationType
- description: Type of action that is executed on readings.
- values:
- - name: Single
- description: Store the latest reading.
- - name: Max
- description: Store maximal reading during defined time period.
- - name: Min
- description: Store minimal reading during defined time period.
- - name: Avg
- description: Calculate average of readings during defined time period.
- - name: Sum
- description: Calculate sum of readings over defined time period.
- - name: ReportingType
- description: >
- The type that defines when Readings are updated.
- values:
- - name: OnChange
- description: >
- On sensor reading change.
- - name: OnRequest
- description: >
- On Update method call.
- - name: Periodic
- description: >
- After period of time defined by Interval property.
- - name: ReportUpdates
- description: >
- The type that defines how Readings are updated.
- values:
- - name: Overwrite
- description: >
- Last sensor reading is written to Readings overwriting the previous
- value. AppendLimit set by user is ignored. Readings size is equal to
- count of all sensors across all metrics.
- - name: AppendWrapsWhenFull
- description: >
- Append sensor reading to Readings up to limit specify in AppendLimit
- then start from the beginning.
- - name: AppendStopsWhenFull
- description: >
- Append sensor reading to Readings up to limit specify in AppendLimit
- then stop till report update.
- - name: NewReport
- description: >
- A new report is created, whose name is the current metric report name
- concatenated with the timestamp.
- - name: CollectionTimescope
- description: >
- The time scope of the related metric values.
- values:
- - name: Point
- description: >
- The corresponding metric apply to a point in time. The reading
- timestamp in Readings property specifies point in time.
- - name: Interval
- description: >
- The corresponding metric apply to a time interval. The reading
- timestamp in Readings property specifies the end of the time interval
- and the collection duration of ReadingParameters specify its duration.
- - name: StartupInterval
- description: >
- The corresponding metric apply to a time interval that began on
- report creation. The reading timestamp in Readings property specifies
- the end of the time interval. Collection duration of
- ReadingParameters specifies the duration between the startup of
- resource and timestamp.
+ - name: OperationType
+ description: Type of action that is executed on readings.
+ values:
+ - name: Single
+ description: Store the latest reading.
+ - name: Max
+ description: Store maximal reading during defined time period.
+ - name: Min
+ description: Store minimal reading during defined time period.
+ - name: Avg
+ description: Calculate average of readings during defined time period.
+ - name: Sum
+ description: Calculate sum of readings over defined time period.
+ - name: ReportingType
+ description: >
+ The type that defines when Readings are updated.
+ values:
+ - name: OnChange
+ description: >
+ On sensor reading change.
+ - name: OnRequest
+ description: >
+ On Update method call.
+ - name: Periodic
+ description: >
+ After period of time defined by Interval property.
+ - name: ReportUpdates
+ description: >
+ The type that defines how Readings are updated.
+ values:
+ - name: Overwrite
+ description: >
+ Last sensor reading is written to Readings overwriting the previous
+ value. AppendLimit set by user is ignored. Readings size is equal to
+ count of all sensors across all metrics.
+ - name: AppendWrapsWhenFull
+ description: >
+ Append sensor reading to Readings up to limit specify in AppendLimit
+ then start from the beginning.
+ - name: AppendStopsWhenFull
+ description: >
+ Append sensor reading to Readings up to limit specify in AppendLimit
+ then stop till report update.
+ - name: NewReport
+ description: >
+ A new report is created, whose name is the current metric report name
+ concatenated with the timestamp.
+ - name: CollectionTimescope
+ description: >
+ The time scope of the related metric values.
+ values:
+ - name: Point
+ description: >
+ The corresponding metric apply to a point in time. The reading
+ timestamp in Readings property specifies point in time.
+ - name: Interval
+ description: >
+ The corresponding metric apply to a time interval. The reading
+ timestamp in Readings property specifies the end of the time interval
+ and the collection duration of ReadingParameters specify its duration.
+ - name: StartupInterval
+ description: >
+ The corresponding metric apply to a time interval that began on
+ report creation. The reading timestamp in Readings property specifies
+ the end of the time interval. Collection duration of
+ ReadingParameters specifies the duration between the startup of
+ resource and timestamp.
diff --git a/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml
index baefb9a..ae8d36f 100644
--- a/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/ReportManager.interface.yaml
@@ -3,71 +3,71 @@
limitations and allows to add report.
methods:
- - name: AddReport
- description: >
- Create new object that represent Report with
- xyz.openbmc_project.Telemetry.Report interface stored in path
- /xyz/openbmc_project/Telemetry/Reports/{Domain}/{Name} where
- Domain and Name are parameters of this method.
- parameters:
- - name: name
- type: string
- description: >
- Defines the name of report to be exposed over D-Bus. Service allows
- to use separator '/' in name to group reports in directory.
- - name: reportingType
- type: enum[xyz.openbmc_project.Telemetry.Report.ReportingType]
- description: Defines report type
- - name: reportUpdates
- type: enum[xyz.openbmc_project.Telemetry.Report.ReportUpdates]
- description: Defines report update type
- - name: appendLimit
- type: size
- description: >
- Defines the maximum number of entries in 'Readings' property.
- - name: emitsReadingsUpdate
- type: boolean
- description: >
- Defines presence of PropertiesChanged signal for
- xyz.openbmc_project.Telmetry.Report.Readings property.
- - name: logToMetricReportsCollection
- type: boolean
- description: >
- Defines presence of Report in Metric Report Collection in Redfish
- Telemetry Service.
- - name: interval
- type: uint64
- description: >
- Defines period of time in milliseconds when Report is updated with
- new readings. Minimal interval is defined in MinInterval property.
- - name: metricParams
- type: array[struct[array[object_path],enum[xyz.openbmc_project.Telemetry.Report.OperationType],string,string,enum[xyz.openbmc_project.Telemetry.Report.CollectionTimescope],uint64]]
- description: >
- Array of metric parameters where first parameter is an array of DBus
- sensor paths. Second parameter specifies operation type. Third is a
- metric Id and fourth is a metadata, both are used to store user
- details. Fifth and sixth are used for collection timescope and
- collection duration.
- returns:
- - name: reportPath
- type: object_path
- description: >
- Path to new report -> /xyz/openbmc_project/Telemetry/Reports/{name}.
+ - name: AddReport
+ description: >
+ Create new object that represent Report with
+ xyz.openbmc_project.Telemetry.Report interface stored in path
+ /xyz/openbmc_project/Telemetry/Reports/{Domain}/{Name} where
+ Domain and Name are parameters of this method.
+ parameters:
+ - name: name
+ type: string
+ description: >
+ Defines the name of report to be exposed over D-Bus. Service allows
+ to use separator '/' in name to group reports in directory.
+ - name: reportingType
+ type: enum[xyz.openbmc_project.Telemetry.Report.ReportingType]
+ description: Defines report type
+ - name: reportUpdates
+ type: enum[xyz.openbmc_project.Telemetry.Report.ReportUpdates]
+ description: Defines report update type
+ - name: appendLimit
+ type: size
+ description: >
+ Defines the maximum number of entries in 'Readings' property.
+ - name: emitsReadingsUpdate
+ type: boolean
+ description: >
+ Defines presence of PropertiesChanged signal for
+ xyz.openbmc_project.Telmetry.Report.Readings property.
+ - name: logToMetricReportsCollection
+ type: boolean
+ description: >
+ Defines presence of Report in Metric Report Collection in Redfish
+ Telemetry Service.
+ - name: interval
+ type: uint64
+ description: >
+ Defines period of time in milliseconds when Report is updated with
+ new readings. Minimal interval is defined in MinInterval property.
+ - name: metricParams
+ type: array[struct[array[object_path],enum[xyz.openbmc_project.Telemetry.Report.OperationType],string,string,enum[xyz.openbmc_project.Telemetry.Report.CollectionTimescope],uint64]]
+ description: >
+ Array of metric parameters where first parameter is an array of DBus
+ sensor paths. Second parameter specifies operation type. Third is a
+ metric Id and fourth is a metadata, both are used to store user
+ details. Fifth and sixth are used for collection timescope and
+ collection duration.
+ returns:
+ - name: reportPath
+ type: object_path
+ description: >
+ Path to new report -> /xyz/openbmc_project/Telemetry/Reports/{name}.
properties:
- - name: MaxReports
- type: size
- description: >
- Contains the max number of metric reports supported by the Telemetry.
- This property is added to be compliant with the Redfish Telemetry
- Service schema, that contains MaxReports property.
- flags:
- - const
- - name: MinInterval
- type: uint64
- description: >
- Minimal allowed time between readings property updates. It limits
- Interval property in xyz.openbmc_project.Telemetry.Report and
- interval parameter in AddReport method.
- flags:
- - const
+ - name: MaxReports
+ type: size
+ description: >
+ Contains the max number of metric reports supported by the Telemetry.
+ This property is added to be compliant with the Redfish Telemetry
+ Service schema, that contains MaxReports property.
+ flags:
+ - const
+ - name: MinInterval
+ type: uint64
+ description: >
+ Minimal allowed time between readings property updates. It limits
+ Interval property in xyz.openbmc_project.Telemetry.Report and
+ interval parameter in AddReport method.
+ flags:
+ - const
diff --git a/yaml/xyz/openbmc_project/Telemetry/Trigger.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/Trigger.interface.yaml
index bb6fd4d..b9984ff 100644
--- a/yaml/xyz/openbmc_project/Telemetry/Trigger.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/Trigger.interface.yaml
@@ -4,91 +4,91 @@
xyz.openbmc_project.Object.Delete for deletion of individual trigger.
properties:
- - name: Discrete
- type: boolean
- description: >
- If true than trigger uses discrete thresholds as threshold conditions.
- Otherwise numeric thresholds is used.
- flags:
- - const
- - name: TriggerActions
- type: array[enum[self.TriggerAction]]
- description: >
- Defines actions which are taken when threshold conditions are met.
- flags:
- - const
- - name: Persistent
- type: boolean
- description: Defines if Trigger is stored in non volatile memory.
- - name: ReportNames
- type: array[string]
- description: >
- Collection of report names that are updated when threshold conditions
- are met. List is ignored if TriggerActions property does not contain
- 'UpdateReport' action.
- - name: Sensors
- type: array[struct[object_path, string]]
- description: >
- Array of sensors that is monitored within trigger. First parameter of a
- structure is a sensor path. Second parameter is a metadata that is used
- to store user data about sensor.
- - name: Thresholds
- type: variant[array[struct[enum[self.Type],uint64,enum[self.Direction],double]],array[struct[string,enum[self.Severity],uint64,string]]]
- description: >
- First type in variant is a collection of numeric thresholds that has
- following fields - type, dwell time, direction and threshold value.
- Second type holds by variant is a collection of discrete thresholds that
- contains following fields - user id, severity, dwell time and threshold
- value. Discrete value does not need to be a number. Numeric threshold
- array is limited by Type enumeration, only 4 elements are allowed.
- Discrete threshold array size is not limited. If discrete threshold
- array is empty than every value change is taken into account of
- threshold condition. Dwell time specify for how long condition has to
- persist to trigger an action.
+ - name: Discrete
+ type: boolean
+ description: >
+ If true than trigger uses discrete thresholds as threshold conditions.
+ Otherwise numeric thresholds is used.
+ flags:
+ - const
+ - name: TriggerActions
+ type: array[enum[self.TriggerAction]]
+ description: >
+ Defines actions which are taken when threshold conditions are met.
+ flags:
+ - const
+ - name: Persistent
+ type: boolean
+ description: Defines if Trigger is stored in non volatile memory.
+ - name: ReportNames
+ type: array[string]
+ description: >
+ Collection of report names that are updated when threshold conditions
+ are met. List is ignored if TriggerActions property does not contain
+ 'UpdateReport' action.
+ - name: Sensors
+ type: array[struct[object_path, string]]
+ description: >
+ Array of sensors that is monitored within trigger. First parameter of a
+ structure is a sensor path. Second parameter is a metadata that is used
+ to store user data about sensor.
+ - name: Thresholds
+ type: variant[array[struct[enum[self.Type],uint64,enum[self.Direction],double]],array[struct[string,enum[self.Severity],uint64,string]]]
+ description: >
+ First type in variant is a collection of numeric thresholds that has
+ following fields - type, dwell time, direction and threshold value.
+ Second type holds by variant is a collection of discrete thresholds that
+ contains following fields - user id, severity, dwell time and threshold
+ value. Discrete value does not need to be a number. Numeric threshold
+ array is limited by Type enumeration, only 4 elements are allowed.
+ Discrete threshold array size is not limited. If discrete threshold
+ array is empty than every value change is taken into account of
+ threshold condition. Dwell time specify for how long condition has to
+ persist to trigger an action.
enumerations:
- - name: TriggerAction
- description: >
- Defines a action which is taken once threshold condition is met.
- values:
- - name: LogToLogService
- description: Trigger will log to journal.
- - name: RedfishEvent
- description: Trigger will log Redfish message.
- - name: UpdateReport
- description: >
- Trigger will update reports. Reports that will be updated are
- specified in ReportNames property.
- - name: Type
- description: >
- Defines a context of a message that is logged when numeric threshold
- condition is met.
- values:
- - name: LowerCritical
- - name: LowerWarning
- - name: UpperWarning
- - name: UpperCritical
- - name: Direction
- description: >
- Defines in which direction threshold value is crossed to fulfill numeric
- threshold condition.
- values:
- - name: Either
- description: >
- Crossing threshold value fulfill numeric threshold condition.
- - name: Decreasing
- description: >
- If threshold value is crossed and previous sensor value was greater
- then threshold value then numeric threshold condition is met.
- - name: Increasing
- description: >
- If threshold value is crossed and previous sensor value was less
- then threshold value then numeric threshold condition is met.
- - name: Severity
- description: >
- Defines a context of a message that is logged when discrete threshold
- condition is met.
- values:
- - name: OK
- - name: Warning
- - name: Critical
+ - name: TriggerAction
+ description: >
+ Defines a action which is taken once threshold condition is met.
+ values:
+ - name: LogToLogService
+ description: Trigger will log to journal.
+ - name: RedfishEvent
+ description: Trigger will log Redfish message.
+ - name: UpdateReport
+ description: >
+ Trigger will update reports. Reports that will be updated are
+ specified in ReportNames property.
+ - name: Type
+ description: >
+ Defines a context of a message that is logged when numeric threshold
+ condition is met.
+ values:
+ - name: LowerCritical
+ - name: LowerWarning
+ - name: UpperWarning
+ - name: UpperCritical
+ - name: Direction
+ description: >
+ Defines in which direction threshold value is crossed to fulfill numeric
+ threshold condition.
+ values:
+ - name: Either
+ description: >
+ Crossing threshold value fulfill numeric threshold condition.
+ - name: Decreasing
+ description: >
+ If threshold value is crossed and previous sensor value was greater
+ then threshold value then numeric threshold condition is met.
+ - name: Increasing
+ description: >
+ If threshold value is crossed and previous sensor value was less
+ then threshold value then numeric threshold condition is met.
+ - name: Severity
+ description: >
+ Defines a context of a message that is logged when discrete threshold
+ condition is met.
+ values:
+ - name: OK
+ - name: Warning
+ - name: Critical
diff --git a/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml
index a384ab0..e92d269 100644
--- a/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml
@@ -2,42 +2,41 @@
Implement to provide triggers management.
methods:
- - name: AddTrigger
- description:
- Create new object that represent Trigger with
- xyz.openbmc_project.Telemetry.Trigger interface stored in path
- /xyz/openbmc_project/Telemetry/Triggers/{Domain}/{Name} where
- Domain and Name are parameters of this method.
- parameters:
- - name: name
- type: string
- description: >
- Defines the name of report to be exposed over D-Bus. Service allows
- to use separator '/' in name to group reports in directory.
- - name: triggerActions
- type: array[enum[xyz.openbmc_project.Telemetry.Trigger.TriggerAction]]
- description: >
- Defines which actions are taken when threshold conditions are met.
- - name: sensors
- type: array[struct[object_path,string]]
- description: >
- Array of sensors that is monitored within trigger. Object path
- points to a sensor in DBus envrionment. String is used as user
- metadata.
- - name: reportNames
- type: array[string]
- description: >
- Collection of report names that are updated when threshold
- conditions are met. This parameter is ignored if triggerActions
- parameter does not contain 'UpdateReport' action.
- - name: thresholds
- type: variant[array[struct[enum[xyz.openbmc_project.Telemetry.Trigger.Type],uint64,enum[xyz.openbmc_project.Telemetry.Trigger.Direction],double]],array[struct[string,enum[xyz.openbmc_project.Telemetry.Trigger.Severity],uint64,string]]]
- description: >
- Contains array of numeric or discrete thresholds that are described
- in xyz.openbmc_project.Telemetry.Trigger interface.
- returns:
- - name: triggerPath
- type: object_path
- description: >
- Path to new trigger ->
- /xyz/openbmc_project/Telemetry/Triggers/{name}.
+ - name: AddTrigger
+ description: Create new object that represent Trigger with
+ xyz.openbmc_project.Telemetry.Trigger interface stored in path
+ /xyz/openbmc_project/Telemetry/Triggers/{Domain}/{Name} where
+ Domain and Name are parameters of this method.
+ parameters:
+ - name: name
+ type: string
+ description: >
+ Defines the name of report to be exposed over D-Bus. Service allows
+ to use separator '/' in name to group reports in directory.
+ - name: triggerActions
+ type: array[enum[xyz.openbmc_project.Telemetry.Trigger.TriggerAction]]
+ description: >
+ Defines which actions are taken when threshold conditions are met.
+ - name: sensors
+ type: array[struct[object_path,string]]
+ description: >
+ Array of sensors that is monitored within trigger. Object path
+ points to a sensor in DBus envrionment. String is used as user
+ metadata.
+ - name: reportNames
+ type: array[string]
+ description: >
+ Collection of report names that are updated when threshold
+ conditions are met. This parameter is ignored if triggerActions
+ parameter does not contain 'UpdateReport' action.
+ - name: thresholds
+ type: variant[array[struct[enum[xyz.openbmc_project.Telemetry.Trigger.Type],uint64,enum[xyz.openbmc_project.Telemetry.Trigger.Direction],double]],array[struct[string,enum[xyz.openbmc_project.Telemetry.Trigger.Severity],uint64,string]]]
+ description: >
+ Contains array of numeric or discrete thresholds that are described
+ in xyz.openbmc_project.Telemetry.Trigger interface.
+ returns:
+ - name: triggerPath
+ type: object_path
+ description: >
+ Path to new trigger ->
+ /xyz/openbmc_project/Telemetry/Triggers/{name}.
diff --git a/yaml/xyz/openbmc_project/Time/EpochTime.interface.yaml b/yaml/xyz/openbmc_project/Time/EpochTime.interface.yaml
index 16724d5..5bbe043 100644
--- a/yaml/xyz/openbmc_project/Time/EpochTime.interface.yaml
+++ b/yaml/xyz/openbmc_project/Time/EpochTime.interface.yaml
@@ -12,5 +12,5 @@
InsufficientPermission means it is not allowed to set time depend
on the time settings.
errors:
- - xyz.openbmc_project.Time.Error.NotAllowed
- - xyz.openbmc_project.Time.Error.Failed
+ - xyz.openbmc_project.Time.Error.NotAllowed
+ - xyz.openbmc_project.Time.Error.Failed
diff --git a/yaml/xyz/openbmc_project/Time/Synchronization.interface.yaml b/yaml/xyz/openbmc_project/Time/Synchronization.interface.yaml
index c63c55b..7e7d35c 100644
--- a/yaml/xyz/openbmc_project/Time/Synchronization.interface.yaml
+++ b/yaml/xyz/openbmc_project/Time/Synchronization.interface.yaml
@@ -10,11 +10,11 @@
enumerations:
- name: Method
description: >
- Possible methods of time synchronization.
+ Possible methods of time synchronization.
values:
- - name: NTP
- description: >
- Sync by using the Network Time Protocol.
- - name: Manual
- description: >
- Sync time manually.
+ - name: NTP
+ description: >
+ Sync by using the Network Time Protocol.
+ - name: Manual
+ description: >
+ Sync time manually.
diff --git a/yaml/xyz/openbmc_project/User/Common.errors.yaml b/yaml/xyz/openbmc_project/User/Common.errors.yaml
index 2bcfb38..ed93ca1 100644
--- a/yaml/xyz/openbmc_project/User/Common.errors.yaml
+++ b/yaml/xyz/openbmc_project/User/Common.errors.yaml
@@ -15,4 +15,4 @@
description: No resource available.
# xyz.openbmc_project.User.Common.Error.PrivilegeMappingExists
- name: PrivilegeMappingExists
- description: Specified privilege mapping already exists.
\ No newline at end of file
+ description: Specified privilege mapping already exists.
diff --git a/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml b/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
index d7af2e8..75a7695 100644
--- a/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
@@ -9,17 +9,17 @@
description: >
Specifies the LDAP URI of the server to connect to.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.Common.Error.NoCACertificate
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.NoCACertificate
- name: LDAPBindDN
type: string
description: >
Specifies the distinguished name with which to bind to the directory
server for lookups.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: LDAPBindDNPassword
type: string
description: >
@@ -38,15 +38,15 @@
description: >
Specifies the base distinguished name to use as search base.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: LDAPSearchScope
type: enum[self.SearchScope]
description: >
Specifies the search scope:subtree, one level or base object.
default: sub
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
- name: LDAPType
type: enum[self.Type]
description: >
@@ -57,8 +57,8 @@
This property is readonly, Once the D-Bus object gets created then
this property should not be modifiable.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.NotAllowed
- name: GroupNameAttribute
type: string
description: >
@@ -74,13 +74,13 @@
description: >
Possible base scopes.
values:
- - name: sub
- - name: one
- - name: base
+ - name: sub
+ - name: one
+ - name: base
- name: Type
description: >
Possible LDAP Types.
values:
- - name: ActiveDirectory
- - name: OpenLdap
+ - name: ActiveDirectory
+ - name: OpenLdap
diff --git a/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml b/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
index 62a5ec4..452bd9e 100644
--- a/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
@@ -10,68 +10,68 @@
properties can be updated as per the
xyz/openbmc_project/User/Ldap/Config.interface.yaml.
parameters:
- - name: LDAPServerURI
- type: string
- description: >
- Specifies the LDAP URI of the server to connect to.
- - name: LDAPBindDN
- type: string
- description: >
- Specifies the distinguished name with which to bind to the
- directory server for lookups.
- - name: LDAPBaseDN
- type: string
- description: >
- Specifies the base distinguished name to use as search base.
- - name: LDAPBINDDNpassword
- type: string
- description: >
- Specifies the clear text credentials with which to bind. This
- option is only applicable when used with LDAPBindDN.
- - name: LDAPSearchScope
- type: enum[self.SearchScope]
- description: >
- Specifies the search scope:subtree, one level or base object.
- - name: LDAPType
- type: enum[self.Type]
- description: >
- Specifies the the configured server is ActiveDirectory(AD) or
- OpenLdap. It's just an indication for the LDAP stack running on
- the BMC, in case the app is implemented in such a way that it has
- to react differently for AD vs openldap.
- - name: GroupNameAttribute
- type: string
- description: >
- Specifies the attribute name that contains the name
- of the Group in the LDAP server.
- - name: UsernameAttribute
- type: string
- description: >
- Specifies the attribute name that contains
- the username in the LDAP server.
+ - name: LDAPServerURI
+ type: string
+ description: >
+ Specifies the LDAP URI of the server to connect to.
+ - name: LDAPBindDN
+ type: string
+ description: >
+ Specifies the distinguished name with which to bind to the
+ directory server for lookups.
+ - name: LDAPBaseDN
+ type: string
+ description: >
+ Specifies the base distinguished name to use as search base.
+ - name: LDAPBINDDNpassword
+ type: string
+ description: >
+ Specifies the clear text credentials with which to bind. This
+ option is only applicable when used with LDAPBindDN.
+ - name: LDAPSearchScope
+ type: enum[self.SearchScope]
+ description: >
+ Specifies the search scope:subtree, one level or base object.
+ - name: LDAPType
+ type: enum[self.Type]
+ description: >
+ Specifies the the configured server is ActiveDirectory(AD) or
+ OpenLdap. It's just an indication for the LDAP stack running on
+ the BMC, in case the app is implemented in such a way that it has
+ to react differently for AD vs openldap.
+ - name: GroupNameAttribute
+ type: string
+ description: >
+ Specifies the attribute name that contains the name
+ of the Group in the LDAP server.
+ - name: UsernameAttribute
+ type: string
+ description: >
+ Specifies the attribute name that contains
+ the username in the LDAP server.
returns:
- - name: path
- type: string
- description: >
- The object path of the D-Bus object representing the config.
+ - name: path
+ type: string
+ description: >
+ The object path of the D-Bus object representing the config.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.Common.Error.NoCACertificate
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.NoCACertificate
enumerations:
- name: SearchScope
description: >
Possible base scopes.
values:
- - name: sub
- - name: one
- - name: base
+ - name: sub
+ - name: one
+ - name: base
- name: Type
description: >
Possible LDAP Types.
values:
- - name: ActiveDirectory
- - name: OpenLdap
+ - name: ActiveDirectory
+ - name: OpenLdap
diff --git a/yaml/xyz/openbmc_project/User/Manager.interface.yaml b/yaml/xyz/openbmc_project/User/Manager.interface.yaml
index f14c53e..532f7af 100644
--- a/yaml/xyz/openbmc_project/User/Manager.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Manager.interface.yaml
@@ -9,53 +9,53 @@
Creates a new user. If the user already exists, then it will throw
an error.
parameters:
- - name: UserName
- type: string
- description: >
- User name which has to be created.
- - name: GroupNames
- type: array[string]
- description: >
- List of groups to which the user has to be added.
- - name: Privilege
- type: string
- description: >
- Privilege of the user to be added.
- - name: Enabled
- type: boolean
- description: >
- User enabled / disabled.
+ - name: UserName
+ type: string
+ description: >
+ User name which has to be created.
+ - name: GroupNames
+ type: array[string]
+ description: >
+ List of groups to which the user has to be added.
+ - name: Privilege
+ type: string
+ description: >
+ Privilege of the user to be added.
+ - name: Enabled
+ type: boolean
+ description: >
+ User enabled / disabled.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InsufficientPermission
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.User.Common.Error.UserNameExists
- - xyz.openbmc_project.User.Common.Error.UserNameGroupFail
- - xyz.openbmc_project.User.Common.Error.UserNamePrivFail
- - xyz.openbmc_project.User.Common.Error.NoResource
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InsufficientPermission
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.User.Common.Error.UserNameExists
+ - xyz.openbmc_project.User.Common.Error.UserNameGroupFail
+ - xyz.openbmc_project.User.Common.Error.UserNamePrivFail
+ - xyz.openbmc_project.User.Common.Error.NoResource
- name: RenameUser
description: >
Rename's existing user to new one. All other properties of the
user will remain same.
parameters:
- - name: UserName
- type: string
- description: >
- User name which has to be updated.
- - name: NewUserName
- type: string
- description: >
- New User name to which user has to be updated.
+ - name: UserName
+ type: string
+ description: >
+ User name which has to be updated.
+ - name: NewUserName
+ type: string
+ description: >
+ New User name to which user has to be updated.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InsufficientPermission
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist
- - xyz.openbmc_project.User.Common.Error.UserNameExists
- - xyz.openbmc_project.User.Common.Error.UserNameGroupFail
- - xyz.openbmc_project.User.Common.Error.UserNamePrivFail
- - xyz.openbmc_project.User.Common.Error.NoResource
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InsufficientPermission
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist
+ - xyz.openbmc_project.User.Common.Error.UserNameExists
+ - xyz.openbmc_project.User.Common.Error.UserNameGroupFail
+ - xyz.openbmc_project.User.Common.Error.UserNamePrivFail
+ - xyz.openbmc_project.User.Common.Error.NoResource
- name: GetUserInfo
description: >
@@ -71,34 +71,34 @@
-user privilege
-remote user flag
parameters:
- - name: UserName
- type: string
- description: >
- User name whose properties have to be returned.
+ - name: UserName
+ type: string
+ description: >
+ User name whose properties have to be returned.
returns:
- - name: UserInfo
- type: dict[string,variant[string,array[string],boolean]]
- description: >
- Dictionary of user properties.
- List of key name and data type of properties below.
- UserPrivilege -> privilege of the user(string)
- UserGroups -> list of groups user belongs to(array[string])
- UserEnabled -> user enabled state(boolean)
- UserLockedForFailedAttempt -> user locked state(boolean)
- UserPasswordExpired -> user password expired(boolean)
- RemoteUser -> remote or local user(boolean)
+ - name: UserInfo
+ type: dict[string,variant[string,array[string],boolean]]
+ description: >
+ Dictionary of user properties.
+ List of key name and data type of properties below.
+ UserPrivilege -> privilege of the user(string)
+ UserGroups -> list of groups user belongs to(array[string])
+ UserEnabled -> user enabled state(boolean)
+ UserLockedForFailedAttempt -> user locked state(boolean)
+ UserPasswordExpired -> user password expired(boolean)
+ RemoteUser -> remote or local user(boolean)
- For detailed documentation of user properties refer
- Attributes.interface.yaml
- examples:
- 1.UserInfo["RemoteUser"] returns true for ldap user
- and false for local user.
- 2.UserInfo["UserGroups"] gets list of groups of user.
+ For detailed documentation of user properties refer
+ Attributes.interface.yaml
+ examples:
+ 1.UserInfo["RemoteUser"] returns true for ldap user
+ and false for local user.
+ 2.UserInfo["UserGroups"] gets list of groups of user.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InsufficientPermission
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InsufficientPermission
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist
properties:
- name: AllPrivileges
@@ -118,11 +118,11 @@
signals:
- name: UserRenamed
description: >
- Signal indicating user's name is updated.
+ Signal indicating user's name is updated.
properties:
- - name: UserName
- type: string
- description: Name of the user which got renamed.
- - name: NewUserName
- type: string
- description: New name of the user.
+ - name: UserName
+ type: string
+ description: Name of the user which got renamed.
+ - name: NewUserName
+ type: string
+ description: New name of the user.
diff --git a/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml b/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
index 87b2872..ef28b45 100644
--- a/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
@@ -20,25 +20,25 @@
description: >
Creates a mapping for the group to the privilege.
parameters:
- - name: GroupName
- type: string
- description: >
- Group Name to which the privilege is to be assigned. In the case
- of LDAP, the GroupName will be the LDAP group the user is part of.
- - name: Privilege
- type: string
- description: >
- The privilege associated with the group. The set of available
- privileges are xyz.openbmc_project.User.Manager.AllPrivileges.
- xyz.openbmc_project.Common.Error.InvalidArgument exception will
- be thrown if the privilege is invalid. Additional documentation
- on privilege is available here.
- https://github.com/openbmc/docs/blob/master/architecture/user-management.md
+ - name: GroupName
+ type: string
+ description: >
+ Group Name to which the privilege is to be assigned. In the case
+ of LDAP, the GroupName will be the LDAP group the user is part of.
+ - name: Privilege
+ type: string
+ description: >
+ The privilege associated with the group. The set of available
+ privileges are xyz.openbmc_project.User.Manager.AllPrivileges.
+ xyz.openbmc_project.Common.Error.InvalidArgument exception will
+ be thrown if the privilege is invalid. Additional documentation
+ on privilege is available here.
+ https://github.com/openbmc/docs/blob/master/architecture/user-management.md
returns:
- - name: Path
- type: path
- description: >
- The path for the created privilege mapping object.
+ - name: Path
+ type: path
+ description: >
+ The path for the created privilege mapping object.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml b/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml
index e629982..4217b91 100644
--- a/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml
@@ -8,9 +8,9 @@
Group Name to which the privilege is to be assigned. In the case of
LDAP, the GroupName will be the LDAP group the user is part of.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.User.Common.Error.PrivilegeMappingExists
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.User.Common.Error.PrivilegeMappingExists
- name: Privilege
type: string
description: >
@@ -22,5 +22,5 @@
https://github.com/openbmc/docs/blob/master/architecture/user-management.md
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
diff --git a/yaml/xyz/openbmc_project/VirtualMedia/Legacy.interface.yaml b/yaml/xyz/openbmc_project/VirtualMedia/Legacy.interface.yaml
index 2a028dd..b55f65a 100644
--- a/yaml/xyz/openbmc_project/VirtualMedia/Legacy.interface.yaml
+++ b/yaml/xyz/openbmc_project/VirtualMedia/Legacy.interface.yaml
@@ -6,32 +6,32 @@
- name: Mount
description: Perform a mount to HOST operation on given object.
parameters:
- - name: ImageURL
- type: string
- description: >
- Url to image. It should start with either `smb://` or
- `https://` prefix
- - name: ReadWrite
- type: boolean
- description: False if the image should be read-only.
- - name: FileDescriptor
- type: variant[int32,unixfd]
- description: >
- File descriptor of named pipe used for passing null-delimited
- secret data (username and password). When there is no data to
- pass `-1` should be passed as `INT`.
+ - name: ImageURL
+ type: string
+ description: >
+ Url to image. It should start with either `smb://` or
+ `https://` prefix
+ - name: ReadWrite
+ type: boolean
+ description: False if the image should be read-only.
+ - name: FileDescriptor
+ type: variant[int32,unixfd]
+ description: >
+ File descriptor of named pipe used for passing null-delimited
+ secret data (username and password). When there is no data to
+ pass `-1` should be passed as `INT`.
returns:
- - name: Status
- type: boolean
- description: mounting status. True on success.
+ - name: Status
+ type: boolean
+ description: mounting status. True on success.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
- name: Unmount
description: Perform an unmount from HOST on given object.
returns:
- - name: Status
- type: boolean
- description: the unmount status. True on success.
+ - name: Status
+ type: boolean
+ description: the unmount status. True on success.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/VirtualMedia/MountPoint.interface.yaml b/yaml/xyz/openbmc_project/VirtualMedia/MountPoint.interface.yaml
index 2ef679e..a9f7ffb 100644
--- a/yaml/xyz/openbmc_project/VirtualMedia/MountPoint.interface.yaml
+++ b/yaml/xyz/openbmc_project/VirtualMedia/MountPoint.interface.yaml
@@ -7,7 +7,7 @@
type: string
description: Name of the Network Block Devices that will be used.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
@@ -15,7 +15,7 @@
type: byte
description: Mounting mode, supported values are 0-proxy, 1-legacy.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
@@ -23,7 +23,7 @@
type: string
description: Name of mounted device.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
@@ -31,18 +31,18 @@
type: string
description: Path to socket used to mount the image.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
- name: Timeout
type: uint16
description: >
- Client connection timeout in seconds.
- If VirtualMedia cannot connect successfully with served
- image the connection is dropped after that timeout.
+ Client connection timeout in seconds.
+ If VirtualMedia cannot connect successfully with served
+ image the connection is dropped after that timeout.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
@@ -50,17 +50,17 @@
type: uint16
description: Size of data block.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
- name: RemainingInactivityTimeout
type: uint16
description: >
- Seconds to drop connection by server, for activated endpoint,
- 0 otherwise.
+ Seconds to drop connection by server, for activated endpoint,
+ 0 otherwise.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
@@ -68,16 +68,16 @@
type: string
description: URL to mounted image.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
- name: WriteProtected
type: boolean
description: >
- Mounting mode, 'True' if the image is read only,
- 'False' otherwise.
+ Mounting mode, 'True' if the image is read only,
+ 'False' otherwise.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/VirtualMedia/Process.interface.yaml b/yaml/xyz/openbmc_project/VirtualMedia/Process.interface.yaml
index 069bc2d..11283a2 100644
--- a/yaml/xyz/openbmc_project/VirtualMedia/Process.interface.yaml
+++ b/yaml/xyz/openbmc_project/VirtualMedia/Process.interface.yaml
@@ -7,7 +7,7 @@
description: >
`True`, if object is occupied by active process, `False` otherwise.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
@@ -16,6 +16,6 @@
description: >
If process terminates this property will contain returned exit code.
flags:
- - const
+ - const
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
\ No newline at end of file
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/VirtualMedia/Proxy.interface.yaml b/yaml/xyz/openbmc_project/VirtualMedia/Proxy.interface.yaml
index a43e8e2..8299c72 100644
--- a/yaml/xyz/openbmc_project/VirtualMedia/Proxy.interface.yaml
+++ b/yaml/xyz/openbmc_project/VirtualMedia/Proxy.interface.yaml
@@ -5,17 +5,17 @@
- name: Mount
description: Perform a mount to HOST operation on given object.
returns:
- - name: Status
- type: boolean
- description: mounting status. True on success.
+ - name: Status
+ type: boolean
+ description: mounting status. True on success.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
- name: Unmount
description: Perform an unmount from HOST on given object.
returns:
- - name: Status
- type: boolean
- description: the unmount status. True on success.
+ - name: Status
+ type: boolean
+ description: the unmount status. True on success.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/VirtualMedia/Stats.interface.yaml b/yaml/xyz/openbmc_project/VirtualMedia/Stats.interface.yaml
index 9895b06..a6ef168 100644
--- a/yaml/xyz/openbmc_project/VirtualMedia/Stats.interface.yaml
+++ b/yaml/xyz/openbmc_project/VirtualMedia/Stats.interface.yaml
@@ -6,7 +6,7 @@
type: uint64
description: Number of read IOs since image mounting.
flags:
- - const
+ - const
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
@@ -14,6 +14,6 @@
type: uint64
description: Number of write IOs since image mounting.
flags:
- - const
+ - const
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
\ No newline at end of file
+ - xyz.openbmc_project.Common.Error.InternalFailure