redfish-codegen 0.3.1

An unopinionated translation of the Redfish specification into Rust.
Documentation 
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322

// Generated by redfish-codegen. Do not modify.

use redfish_macros::IntoRedfishMessage;

/// This registry defines the messages for storage devices.
#[derive(Clone, Debug, IntoRedfishMessage)]
#[message(crate::models::message::v1_1_2::Message)]
pub enum StorageDevice {
    /// This message shall be used to indicate a volume offline condition was detected.  This may occur if the volume configuration is not supported or needs to be imported.
    #[message(message = "The volume '%1' attached to the storage controller located in '%2' is offline.")]
    #[message(id = "StorageDevice.1.1.0.VolumeOffine")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Use storage sofware to enable, repair, or import the volume.  You may also delete or move volume back to the original controller.")]
    VolumeOffine(
        /// The value of this argument shall be a string containing an identifier for the volume.  The identifier may contain `Id`, `Name`, `Identifiers`, `LogicalUnitNumber`, or other data used to uniquely identify the volume.
        String,
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate a drive predictive failure condition has been detected.
    #[message(message = "A predictive failure condition for the drive located in '%1' has been detected.")]
    #[message(id = "StorageDevice.1.1.0.DrivePredictiveFailure")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "If this drive is not part of a fault-tolerant volume, first back up all data, then replace the drive and restore all data afterward.  If this drive is part of a fault-tolerant volume, replace this drive as soon as possible as long as the volume health is OK.")]
    DrivePredictiveFailure(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate a drive has been removed.
    #[message(message = "The drive located in '%1' was removed.")]
    #[message(id = "StorageDevice.1.1.0.DriveRemoved")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "If the drive is still displayed, attempt to refresh the cached data.")]
    DriveRemoved(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate that the storage controller password was accepted.  Normally this is used by storage controllers that require a controller password during boot to unlock encrypted volumes or drives.
    #[message(message = "A password was entered for the storage controller located in '%1'.")]
    #[message(id = "StorageDevice.1.1.0.ControllerPasswordAccepted")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action required.")]
    ControllerPasswordAccepted(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate the write cache is reporting loss of data in posted-writes cache memory due to loss of battery power when the server lost power or a hardware error.
    #[message(message = "The write cache on the storage controller located in '%1' has data loss.")]
    #[message(id = "StorageDevice.1.1.0.WriteCacheDataLoss")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Check the controller resource properties to determine cause of the write cache data loss.")]
    WriteCacheDataLoss(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate a battery health has changed to OK.
    #[message(message = "The health of the battery located in '%1' has changed to OK.")]
    #[message(id = "StorageDevice.1.1.0.BatteryOK")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    BatteryOK(
        /// The value of this argument shall be a string containing the battery location.
        String,
    ),
    /// This message shall be used to indicate that an unreported storage controller error condition has been detected prior to reboot.
    #[message(message = "A previous error condition for the storage controller located in '%1' has been detected due to '%2'.")]
    #[message(id = "StorageDevice.1.1.0.ControllerPreviousError")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "Update the controller to the latest firmware version.  If the issue persists, replace the controller.")]
    ControllerPreviousError(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
        /// The value of this argument shall be a string containing the reason for failure.
        String,
    ),
    /// This message shall be used to indicate a controller port degraded condition has been detected.
    #[message(message = "A degraded condition for the controller port located in '%1' has been detected due to reason '%2'.")]
    #[message(id = "StorageDevice.1.1.0.ControllerPortDegraded")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "Ensure all cables are properly and securly connected.  Replace faulty cables.")]
    ControllerPortDegraded(
        /// The value of this argument shall be a string containing the controller port location.
        String,
        /// The value of this argument shall be a string containing the reason for the degraded controller port.
        String,
    ),
    /// This message shall be used to indicate a volume online condition was detected.
    #[message(message = "The volume '%1' attached to the storage controller located in '%2' is online.")]
    #[message(id = "StorageDevice.1.1.0.VolumeOfflineCleared")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    VolumeOfflineCleared(
        /// The value of this argument shall be a string containing an identifier for the volume.  The identifier may contain `Id`, `Name`, `Identifiers`, `LogicalUnitNumber`, or other data used to uniquely identify the volume.
        String,
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate a controller write cache state is in protected mode.
    #[message(message = "The write cache state on the storage controller located in '%1' is in protected mode.")]
    #[message(id = "StorageDevice.1.1.0.WriteCacheProtected")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    WriteCacheProtected(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate a battery is below the required capacity and is charging.
    #[message(message = "A charging condition for the battery located in '%1' has been detected.")]
    #[message(id = "StorageDevice.1.1.0.BatteryCharging")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "No action needed.  There may be reduced performance and features while the battery is charging.")]
    BatteryCharging(
        /// The value of this argument shall be a string containing the battery location.
        String,
    ),
    /// This message shall be used to indicate a predictive failure condition on a drive has been cleared, but any other failure conditions remain.
    #[message(message = "A predictive failure condition for the drive located in '%1' has been cleared.")]
    #[message(id = "StorageDevice.1.1.0.DrivePredictiveFailureCleared")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    DrivePredictiveFailureCleared(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate a drive offline condition has been cleared.
    #[message(message = "An offline condition for the the drive located in '%1' has been cleared.")]
    #[message(id = "StorageDevice.1.1.0.DriveOfflineCleared")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    DriveOfflineCleared(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate a drive has been inserted.
    #[message(message = "The drive located in '%1' was inserted.")]
    #[message(id = "StorageDevice.1.1.0.DriveInserted")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "If the drive is not properly displayed, attempt to refresh the cached data.")]
    DriveInserted(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate a battery failure condition has been detected.
    #[message(message = "A failure condition for the battery located in '%1' has been detected.")]
    #[message(id = "StorageDevice.1.1.0.BatteryFailure")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Ensure all cables are properly and securely connected.  Replace the failed battery.")]
    BatteryFailure(
        /// The value of this argument shall be a string containing the battery location.
        String,
    ),
    /// This message shall be used to indicate that a storage controller failure condition has been detected due to a hardware, communication, or firmware failure.
    #[message(message = "A failure condition for the storage controller located in '%1' has been detected.")]
    #[message(id = "StorageDevice.1.1.0.ControllerFailure")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Reseat the storage controller in the PCI slot.  Update the controller to the latest firmware version.  If the issue persists, replace the controller.")]
    ControllerFailure(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate a volume degraded condition was detected due to one or more drives not installed correctly, missing, or has failed.
    #[message(message = "The volume '%1' attached to the storage controller located in '%2' is degraded.")]
    #[message(id = "StorageDevice.1.1.0.VolumeDegraded")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "Ensure all cables are properly and securely connected.  Replace failed drives.")]
    VolumeDegraded(
        /// The value of this argument shall be a string containing an identifier for the volume.  The identifier may contain `Id`, `Name`, `Identifiers`, `LogicalUnitNumber`, or other data used to uniquely identify the volume.
        String,
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate a drive that is required by the configuration is missing.  This message shall exist any time a volume is degraded or failed due to a missing drive.
    #[message(message = "A missing condition for the drive located in '%1' has been detected.")]
    #[message(id = "StorageDevice.1.1.0.DriveMissing")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Ensure all cables are properly and securely connected.  Ensure all drives are fully seated.  Replace the defective cables, drive, or both.  Delete the volume if no longer needed.")]
    DriveMissing(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate the write cache state degraded due to a missing battery or hardware failure.
    #[message(message = "The write cache state on the storage controller located in '%1' is degraded.")]
    #[message(id = "StorageDevice.1.1.0.WriteCacheDegraded")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Check the controller to determine the cause of write cache degraded state, such as a missing battery or hardware failure.")]
    WriteCacheDegraded(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate that the storage controller health has changed to OK.
    #[message(message = "The health of the storage controller located in '%1' has changed to OK.")]
    #[message(id = "StorageDevice.1.1.0.ControllerOK")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action required.")]
    ControllerOK(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate a previous drive missing condition has been cleared.
    #[message(message = "A missing condition for the drive located in '%1' has been cleared.")]
    #[message(id = "StorageDevice.1.1.0.DriveMissingCleared")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    DriveMissingCleared(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate a drive health has changed to OK.
    #[message(message = "The health of the drive located in '%1' has changed to OK.")]
    #[message(id = "StorageDevice.1.1.0.DriveOK")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    DriveOK(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate a drive offline condition has been detected.  This may occur when a drive is unconfigured, encrypted by a foreign controller, offline during a background operation, or unsupported.
    #[message(message = "An offline condition for the the drive located in '%1' has been detected.")]
    #[message(id = "StorageDevice.1.1.0.DriveOffline")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "If the drive is unconfigured or needs an import, configure the drive.  If the drive operation is in progress, wait for the operation to complete.  If the drive is not supported, replace it.")]
    DriveOffline(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate a volume health has changed to OK.
    #[message(message = "The health of volume '%1' that is attached to the storage controller located in '%2' has changed to OK.")]
    #[message(id = "StorageDevice.1.1.0.VolumeOK")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    VolumeOK(
        /// The value of this argument shall be a string containing an identifier for the volume.  The identifier may contain `Id`, `Name`, `Identifiers`, `LogicalUnitNumber`, or other data used to uniquely identify the volume.
        String,
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate a battery that is required by the configuration is missing.
    #[message(message = "The battery located in '%1' is missing.")]
    #[message(id = "StorageDevice.1.1.0.BatteryMissing")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Attach the battery.  Ensure all cables are properly and securely connected.")]
    BatteryMissing(
        /// The value of this argument shall be a string containing the battery location.
        String,
    ),
    /// This message shall be used to indicate a failure condition on a drive has been cleared, but any predictive failure or other conditions remain.
    #[message(message = "A failure condition for the drive located in '%1' has been cleared.")]
    #[message(id = "StorageDevice.1.1.0.DriveFailureCleared")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    DriveFailureCleared(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
    /// This message shall be used to indicate a controller port failure condition has been detected.
    #[message(message = "A failure condition for the controller port located in '%1' has been detected.")]
    #[message(id = "StorageDevice.1.1.0.ControllerPortFailure")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Ensure all cables are properly and securly connected.  Replace faulty cables.")]
    ControllerPortFailure(
        /// The value of this argument shall be a string containing the controller port location.
        String,
    ),
    /// This message shall be used to indicate a controller port health has changed to OK.
    #[message(message = "The health of the controller port located in '%1' has changed to OK.")]
    #[message(id = "StorageDevice.1.1.0.ControllerPortOK")]
    #[message(severity = "crate::models::resource::Health::OK")]
    #[message(resolution = "No action needed.")]
    ControllerPortOK(
        /// The value of this argument shall be a string containing the controller port location.
        String,
    ),
    /// This message shall be used to indicate a volume failure condition was detected due to one or more drives not installed correctly, missing, or has failed.
    #[message(message = "The volume '%1' attached to the storage controller located in '%2' has failed.")]
    #[message(id = "StorageDevice.1.1.0.VolumeFailure")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Ensure all cables are properly and securely connected.  Ensure all drives are fully seated and operational.")]
    VolumeFailure(
        /// The value of this argument shall be a string containing an identifier for the volume.  The identifier may contain `Id`, `Name`, `Identifiers`, `LogicalUnitNumber`, or other data used to uniquely identify the volume.
        String,
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate write cache state temporarily degraded due to battery charging or data recovery rebuild operation pending.
    #[message(message = "The write cache state on the storage controller located in '%1' is temporarily degraded.")]
    #[message(id = "StorageDevice.1.1.0.WriteCacheTemporarilyDegraded")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "Check the controller to determine the cause of write cache temporarily degraded state, such as a battery is charging or a data recovery rebuild operation is pending.")]
    WriteCacheTemporarilyDegraded(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate that a storage controller degraded condition has been detected.
    #[message(message = "A degraded condition for the storage controller located in '%1' has been detected due to reason '%2'.")]
    #[message(id = "StorageDevice.1.1.0.ControllerDegraded")]
    #[message(severity = "crate::models::resource::Health::Warning")]
    #[message(resolution = "Reseat the storage controller in the PCI slot.  Update the controller to the latest firmware version.  If the issue persists, replace the controller.")]
    ControllerDegraded(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
        /// The value of this argument shall be a string containing the reason for the degraded controller.
        String,
    ),
    /// This message shall be used to indicate that the storage controller requires a password.  Normally this is used by storage controllers that require a controller password during boot to unlock encrypted volumes or drives.
    #[message(message = "The storage controller located in '%1' requires a password.")]
    #[message(id = "StorageDevice.1.1.0.ControllerPasswordRequired")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Enter the controller password.")]
    ControllerPasswordRequired(
        /// The value of this argument shall be a string containing the storage controller location.
        String,
    ),
    /// This message shall be used to indicate a drive failure condition detected due to a drive not installed correctly or has failed.
    #[message(message = "A failure condition for the drive located in '%1' has been detected.")]
    #[message(id = "StorageDevice.1.1.0.DriveFailure")]
    #[message(severity = "crate::models::resource::Health::Critical")]
    #[message(resolution = "Ensure all cables are properly and securely connected.  Ensure all drives are fully seated.  Replace the defective cables, drive, or both.")]
    DriveFailure(
        /// The value of this argument shall be a string containing the drive location.
        String,
    ),
}