summaryrefslogtreecommitdiffstats
path: root/xyz/openbmc_project/Control/Host.interface.yaml
blob: 52abf5f3189a2d46d0a5339b805d01070354be9d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
description: >
    Implement to provide host interface support

methods:
    - name: Execute
      description: >
          Execute the requested command by the caller. This command will be
          processed in first in first out order. See the Command enum
          description below for details on all supported commands.
      parameters:
          - name: command
            type: enum[self.Command]
            description: Requested command to execute against the host
      errors:
          - self.Error.CommandNotSupported

signals:
    - name: CommandComplete
      description: >
        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

enumerations:
    - name: Command
      description: >
        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: >
            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
      values:
        - name: Success
          description: Command execution was a success
        - name: Failure
          description: Command execution was a failure
OpenPOWER on IntegriCloud