xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Control/FieldMode.interface.yaml (revision 8da396ca4e24c1831d5d8fc9c9afc208002032c1) 
1*b1b4d261SWilliam A. Kennington IIIdescription: >
2*b1b4d261SWilliam A. Kennington III    An interface to enable field mode, which, when enabled, indicates that the
3*b1b4d261SWilliam A. Kennington III    system is in production.
4*b1b4d261SWilliam A. Kennington III
5*b1b4d261SWilliam A. Kennington IIIproperties:
6*b1b4d261SWilliam A. Kennington III    - name: FieldModeEnabled
7*b1b4d261SWilliam A. Kennington III      type: boolean
8*b1b4d261SWilliam A. Kennington III      description: >
9*b1b4d261SWilliam A. Kennington III          Keeps track of whether the BMC is in field mode. Enabling field mode
10*b1b4d261SWilliam A. Kennington III          is intended to be a one-way operation. Therefore the application
11*b1b4d261SWilliam A. Kennington III          implementing this interface could return a NotAllowed error when the
12*b1b4d261SWilliam A. Kennington III          user attempts to set the property value to false.
13*b1b4d261SWilliam A. Kennington III      default: false
14*b1b4d261SWilliam A. Kennington III      errors:
15*b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.NotAllowed
16