xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Inventory/Item/Drive.interface.yaml (revision f1260d35fcc05155744347cb33526869d295c484)
1description: >
2    Implement to provide drive attributes.
3
4properties:
5    - name: Capacity
6      default: 0
7      type: uint64
8      description: >
9          The size in bytes of the Drive. `0` if cannot be determined.
10    - name: Protocol
11      default: Unknown
12      type: enum[self.DriveProtocol]
13      description: >
14          The communication protocol used by the Drive.
15    - name: Type
16      default: Unknown
17      type: enum[self.DriveType]
18      description: >
19          The type of physical form factor of the Drive.
20    - name: EncryptionStatus
21      default: Unknown
22      type: enum[self.DriveEncryptionState]
23      description: >
24          The current state of encryption on the drive.
25    - name: LockedStatus
26      default: Unknown
27      type: enum[self.DriveLockState]
28      description: >
29          Indicates if the data on the drive is accessible.
30          This does not correspond to write locked
31    - name: PredictedMediaLifeLeftPercent
32      default: maxint
33      type: byte
34      description: >
35          How much of the drives life is remaining in a percentage from 0-100 .
36          If the reading the value is not supported returns the max value for
37          the type (255).
38
39enumerations:
40    - name: DriveProtocol
41      description: >
42          Possible communication protocol types
43      values:
44          - name: SAS
45            description: >
46                Serial Attached SCSI.
47          - name: SATA
48            description: >
49                Serial AT Attachment.
50          - name: NVMe
51            description: >
52                Non-Volatile Memory Express.
53          - name: FC
54            description: >
55                Fibre Channel.
56          - name: Unknown
57            description: >
58                The Drive protocol is unknown.
59    - name: DriveType
60      description: >
61          Possible Drive type
62      values:
63          - name: HDD
64            description: >
65                A hard disk drive is an electro-mechanical data storage device
66                that stores and retrieves digital data using magnetic storage.
67          - name: SSD
68            description: >
69                A solid-state drive is a solid-state storage device that uses
70                integrated circuit assemblies to store data persistently.
71          - name: Unknown
72            description: >
73                The Drive type is unknown.
74    - name: DriveEncryptionState
75      description: >
76          Possible encryption states drives could have
77      values:
78          - name: Encrypted
79            description: >
80                The drive is in an encrypted state.
81          - name: Unencrypted
82            description: >
83                The drive in in an unencrypted state.
84          - name: Unknown
85            description: >
86                The encryption state of the drive is not known.
87    - name: DriveLockState
88      description: >
89          Possible lock states drives could have
90      values:
91          - name: Locked
92            description: >
93                The drive is in a locked state.
94          - name: Unlocked
95            description: >
96                The drive in in unlocked state.
97          - name: Unknown
98            description: >
99                The locked state of the drive is not known.
100