blob: ba0f823c2366bd4c685646e0cdcf8ed994416e23 [file] [log] [blame]
Suryakanth Sekar77a74262019-02-13 18:06:14 +05301description: >
Patrick Williamsa1347412022-12-06 10:56:22 -06002 Remote BIOS Config manager daemon will create payload objects for every
3 payload received in the system under object path
4 /xyz/openbmc_project/biosconfigMgr/<PayloadType>. Password interface is used
5 to change and verify the BIOS setup Password
Suryakanth Sekar77a74262019-02-13 18:06:14 +05306methods:
7 - name: ChangePassword
8 description: >
9 Change the BIOS setup password.
10 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050011 - name: UserName
12 type: string
13 description: >
14 User name - user / admin.
15 - name: CurrentPassword
16 type: string
17 description: >
18 Current user/ admin Password.
19 - name: NewPassword
20 type: string
21 description: >
22 New user/ admin Password.
Suryakanth Sekar77a74262019-02-13 18:06:14 +053023 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050024 - xyz.openbmc_project.Common.Error.InternalFailure
25 - xyz.openbmc_project.BIOSConfig.Common.Error.PasswordNotSettable
26 - xyz.openbmc_project.BIOSConfig.Common.Error.InvalidCurrentPassword
Suryakanth Sekar77a74262019-02-13 18:06:14 +053027
28properties:
Patrick Williams8da396c2022-03-14 14:21:02 -050029 - name: PasswordInitialized
30 type: boolean
31 description: >
32 To indicate BIOS password related details are recevied or not.