summaryrefslogtreecommitdiffstats
path: root/xyz/openbmc_project/Control/Service/Attributes.interface.yaml
blob: e9bfc928794106c162fad547d0428327e6142673 (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
description: >
    This interface exposes properties for service objects like
    SSH, web, RMCP+ etc. under the service configuration manager.
    This interface can be used to get/set of service properties.

properties:
    - name: State
      type: enum[self.SupportedStates]
      description: >
          Specifies the state of the service.
    - name: Port
      type: uint32
      description: >
          Specifies the listening port number of service.
          This property is used to get or set the service
          listening port number.
    - name: Channel
      type: array[string]
      description: >
          Specifies the channel on which service allows client
          connections. This property is used to get or set the
          allowed channel interfaces in array of strings. It accepts
          the interface names, which are created as objects in
          network service and returns error if not found.

enumerations:
    - name: SupportedStates
      description: >
          State values.
      values:
        - name: 'enabled'
          description: >
            Service is enabled.
        - name: 'disabled'
          description: >
            Service is disabled.
OpenPOWER on IntegriCloud