redfish_codegen/registries/resource_event/
v1_3_0.rs

1// Generated by redfish-codegen. Do not modify.
2
3use redfish_macros::IntoRedfishMessage;
4
5/// This registry defines the messages to use for resource events.
6#[derive(Clone, Debug, IntoRedfishMessage)]
7#[message(crate::models::message::v1_1_2::Message)]
8pub enum ResourceEvent {
9    /// This message shall be used to indicate that the value of the PowerState property of a resource has changed to `PoweringOff`.  This message should not be used if the PowerState transition to `Off` will occur immediately.
10    #[message(message = "The resource `%1` is powering off.")]
11    #[message(id = "ResourceEvent.1.3.0.ResourcePoweringOff")]
12    #[message(severity = "crate::models::resource::Health::OK")]
13    #[message(resolution = "None.")]
14    ResourcePoweringOff(
15        /// This argument shall contain the name of the relevant Redfish resource.
16        String,
17    ),
18    /// This message shall be used to indicate that the value of the PowerState property of a resource has changed to `Paused`.
19    #[message(message = "The resource `%1` has been paused.")]
20    #[message(id = "ResourceEvent.1.3.0.ResourcePaused")]
21    #[message(severity = "crate::models::resource::Health::OK")]
22    #[message(resolution = "None.")]
23    ResourcePaused(
24        /// This argument shall contain the name of the relevant Redfish resource.
25        String,
26    ),
27    /// This message shall be used to indicate that the URI for a resource has changed.
28    #[message(message = "The URI for the resource has changed.")]
29    #[message(id = "ResourceEvent.1.3.0.URIForResourceChanged")]
30    #[message(severity = "crate::models::resource::Health::OK")]
31    #[message(resolution = "None.")]
32    URIForResourceChanged,
33
34    /// This message shall be used to indicate that a specified resource property has cleared its error threshold.
35    #[message(message = "The resource property %1 has cleared the error threshold of value %2.")]
36    #[message(id = "ResourceEvent.1.3.0.ResourceErrorThresholdCleared")]
37    #[message(severity = "crate::models::resource::Health::OK")]
38    #[message(resolution = "None.")]
39    ResourceErrorThresholdCleared(
40        /// This argument shall contain the name of the relevant property from a Redfish resource.
41        String,
42        /// This argument shall contain the value of the relevant error threshold.
43        f64,
44    ),
45    /// This message shall be used to indicate that the health of a resource has changed to Warning.
46    #[message(message = "The health of resource `%1` has changed to %2.")]
47    #[message(id = "ResourceEvent.1.3.0.ResourceStatusChangedWarning")]
48    #[message(severity = "crate::models::resource::Health::Warning")]
49    #[message(resolution = "None.")]
50    ResourceStatusChangedWarning(
51        /// This argument shall contain the name of the relevant Redfish resource.
52        String,
53        /// This argument shall contain the value of the `Health` property for the relevant Redfish resource.  The values shall be used from the definition of the `Health` enumeration in the `Resource` schema.
54        String,
55    ),
56    /// This message shall be used to indicate that the health of a resource has changed to Critical.
57    #[message(message = "The health of resource `%1` has changed to %2.")]
58    #[message(id = "ResourceEvent.1.3.0.ResourceStatusChangedCritical")]
59    #[message(severity = "crate::models::resource::Health::Critical")]
60    #[message(resolution = "None.")]
61    ResourceStatusChangedCritical(
62        /// This argument shall contain the name of the relevant Redfish resource.
63        String,
64        /// This argument shall contain the value of the `Health` property for the relevant Redfish resource.  The values shall be used from the definition of the `Health` enumeration in the `Resource` schema.
65        String,
66    ),
67    /// This message shall be used to indicate that the value of the PowerState property of a resource has changed to `Off`.
68    #[message(message = "The resource `%1` has powered off.")]
69    #[message(id = "ResourceEvent.1.3.0.ResourcePoweredOff")]
70    #[message(severity = "crate::models::resource::Health::OK")]
71    #[message(resolution = "None.")]
72    ResourcePoweredOff(
73        /// This argument shall contain the name of the relevant Redfish resource.
74        String,
75    ),
76    /// This message shall be used to indicate that the value of the State property of a resource has changed.
77    #[message(message = "The state of resource `%1` has changed to %2.")]
78    #[message(id = "ResourceEvent.1.3.0.ResourceStateChanged")]
79    #[message(severity = "crate::models::resource::Health::OK")]
80    #[message(resolution = "None.")]
81    ResourceStateChanged(
82        /// This argument shall contain the name of the relevant Redfish resource.
83        String,
84        /// This argument shall contain the value of the `State` property for the relevant Redfish resource.  The values shall be used from the definition of the `State` enumeration in the `Resource` schema.
85        String,
86    ),
87    /// This message shall be used to indicate that an incompatible version of software has been detected.
88    #[message(message = "An incompatible version of software '%1' has been detected.")]
89    #[message(id = "ResourceEvent.1.3.0.ResourceVersionIncompatible")]
90    #[message(severity = "crate::models::resource::Health::Warning")]
91    #[message(resolution = "Compare the version of the resource with the compatible version of the software.")]
92    ResourceVersionIncompatible(
93        /// This argument shall contain the name of the relevant software component or package.  This might include both name and version information.
94        String,
95    ),
96    /// This message shall be used to indicate that one or more resource properties have changed.
97    #[message(message = "One or more resource properties have changed.")]
98    #[message(id = "ResourceEvent.1.3.0.ResourceChanged")]
99    #[message(severity = "crate::models::resource::Health::OK")]
100    #[message(resolution = "None.")]
101    ResourceChanged,
102
103    /// This message shall be used to indicate that a license has expired.
104    #[message(message = "A license for '%1' has expired.  The following message was returned: '%2'.")]
105    #[message(id = "ResourceEvent.1.3.0.LicenseExpired")]
106    #[message(severity = "crate::models::resource::Health::Warning")]
107    #[message(resolution = "See vendor specific instructions for specific actions.")]
108    LicenseExpired(
109        /// This argument shall contain the name of the relevant resource or service affected by the software license.
110        String,
111        /// This argument shall contain the message returned from the license validation process or software.
112        String,
113    ),
114    /// This message shall be used to indicate a test of a event delivery mechanism, such as the creation of a LogEntry resource or an event transmission.
115    #[message(message = "Test message.")]
116    #[message(id = "ResourceEvent.1.3.0.TestMessage")]
117    #[message(severity = "crate::models::resource::Health::OK")]
118    #[message(resolution = "None.")]
119    TestMessage,
120
121    /// This message shall be used to indicate that a specified resource property has exceeded its error threshold.
122    #[message(message = "The resource property %1 has exceeded error threshold of value %2.")]
123    #[message(id = "ResourceEvent.1.3.0.ResourceErrorThresholdExceeded")]
124    #[message(severity = "crate::models::resource::Health::Critical")]
125    #[message(resolution = "None.")]
126    ResourceErrorThresholdExceeded(
127        /// This argument shall contain the name of the relevant property from a Redfish resource.
128        String,
129        /// This argument shall contain the value of the relevant error threshold.
130        f64,
131    ),
132    /// This message shall be used to indicate that a specified resource property has corrected errors.
133    #[message(message = "The resource property %1 has corrected errors of type '%2'.")]
134    #[message(id = "ResourceEvent.1.3.0.ResourceErrorsCorrected")]
135    #[message(severity = "crate::models::resource::Health::OK")]
136    #[message(resolution = "None.")]
137    ResourceErrorsCorrected(
138        /// This argument shall contain the name of the relevant property from a Redfish resource.
139        String,
140        /// This argument shall contain a description of the type of error encountered.
141        String,
142    ),
143    /// This message shall be used to indicate that a self-test has completed.
144    #[message(message = "A self-test has completed.")]
145    #[message(id = "ResourceEvent.1.3.0.ResourceSelfTestCompleted")]
146    #[message(severity = "crate::models::resource::Health::OK")]
147    #[message(resolution = "None.")]
148    ResourceSelfTestCompleted,
149
150    /// This message shall be used to indicate that a specified resource property has detected errors.
151    #[message(message = "The resource property %1 has detected errors of type '%2'.")]
152    #[message(id = "ResourceEvent.1.3.0.ResourceErrorsDetected")]
153    #[message(severity = "crate::models::resource::Health::Warning")]
154    #[message(resolution = "Resolution dependent upon error type.")]
155    ResourceErrorsDetected(
156        /// This argument shall contain the name of the relevant property from a Redfish resource.
157        String,
158        /// This argument shall contain a description of the type of error encountered.
159        String,
160    ),
161    /// This message shall be used to indicate that a specified resource property has cleared its warning threshold.
162    #[message(message = "The resource property %1 has cleared the warning threshold of value %2.")]
163    #[message(id = "ResourceEvent.1.3.0.ResourceWarningThresholdCleared")]
164    #[message(severity = "crate::models::resource::Health::OK")]
165    #[message(resolution = "None.")]
166    ResourceWarningThresholdCleared(
167        /// This argument shall contain the name of the relevant property from a Redfish resource.
168        String,
169        /// This argument shall contain the value of the relevant error threshold.
170        f64,
171    ),
172    /// This message shall be used to indicates that all conditions of a successful creation operation have been met.
173    #[message(message = "The resource has been created successfully.")]
174    #[message(id = "ResourceEvent.1.3.0.ResourceCreated")]
175    #[message(severity = "crate::models::resource::Health::OK")]
176    #[message(resolution = "None")]
177    ResourceCreated,
178
179    /// This message shall be used to indicate that a license has been added.
180    #[message(message = "A license for '%1' has been added.  The following message was returned: '%2'.")]
181    #[message(id = "ResourceEvent.1.3.0.LicenseAdded")]
182    #[message(severity = "crate::models::resource::Health::OK")]
183    #[message(resolution = "See vendor specific instructions for specific actions.")]
184    LicenseAdded(
185        /// This argument shall contain the name of the relevant resource or service affected by the software license.
186        String,
187        /// This argument shall contain the message returned from the license validation process or software.
188        String,
189    ),
190    /// This message shall be used to indicate that the health of a resource has changed to OK.
191    #[message(message = "The health of resource '%1' has changed to %2.")]
192    #[message(id = "ResourceEvent.1.3.0.ResourceStatusChangedOK")]
193    #[message(severity = "crate::models::resource::Health::OK")]
194    #[message(resolution = "None.")]
195    ResourceStatusChangedOK(
196        /// This argument shall contain the name of the relevant Redfish resource.
197        String,
198        /// This argument shall contain the value of the `Health` property for the relevant Redfish resource.  The values shall be used from the definition of the `Health` enumeration in the `Resource` schema.
199        String,
200    ),
201    /// This message shall be used to indicate that the value of the PowerState property of a resource has changed to `On`.
202    #[message(message = "The resource `%1` has powered on.")]
203    #[message(id = "ResourceEvent.1.3.0.ResourcePoweredOn")]
204    #[message(severity = "crate::models::resource::Health::OK")]
205    #[message(resolution = "None.")]
206    ResourcePoweredOn(
207        /// This argument shall contain the name of the relevant Redfish resource.
208        String,
209    ),
210    /// This message shall be used to indicates that all conditions of a successful remove operation have been met.
211    #[message(message = "The resource has been removed successfully.")]
212    #[message(id = "ResourceEvent.1.3.0.ResourceRemoved")]
213    #[message(severity = "crate::models::resource::Health::OK")]
214    #[message(resolution = "None")]
215    ResourceRemoved,
216
217    /// This message shall be used to indicate that a self-test has failed.
218    #[message(message = "A self-test has failed.  The following message was returned: '%1'.")]
219    #[message(id = "ResourceEvent.1.3.0.ResourceSelfTestFailed")]
220    #[message(severity = "crate::models::resource::Health::Critical")]
221    #[message(resolution = "See vendor specific instructions for specific actions.")]
222    ResourceSelfTestFailed(
223        /// This argument shall contain the error message received as a result from the self-test.
224        String,
225    ),
226    /// This message shall be used to indicate that a specified resource property has exceeded its warning threshold.
227    #[message(message = "The resource property %1 has exceeded its warning threshold of value %2.")]
228    #[message(id = "ResourceEvent.1.3.0.ResourceWarningThresholdExceeded")]
229    #[message(severity = "crate::models::resource::Health::Warning")]
230    #[message(resolution = "None.")]
231    ResourceWarningThresholdExceeded(
232        /// This argument shall contain the name of the relevant property from a Redfish resource.
233        String,
234        /// This argument shall contain the value of the relevant error threshold.
235        f64,
236    ),
237    /// This message shall be used to indicate that a license has changed.
238    #[message(message = "A license for '%1' has changed.  The following message was returned: '%2'.")]
239    #[message(id = "ResourceEvent.1.3.0.LicenseChanged")]
240    #[message(severity = "crate::models::resource::Health::Warning")]
241    #[message(resolution = "See vendor specific instructions for specific actions.")]
242    LicenseChanged(
243        /// This argument shall contain the name of the relevant resource or service affected by the software license.
244        String,
245        /// This argument shall contain the message returned from the license validation process or software.
246        String,
247    ),
248    /// This message shall be used to indicate that the value of the PowerState property of a resource has changed to `PoweringOn`.  This message should not be used if the PowerState transition to `On` will occur immediately.
249    #[message(message = "The resource `%1` is powering on.")]
250    #[message(id = "ResourceEvent.1.3.0.ResourcePoweringOn")]
251    #[message(severity = "crate::models::resource::Health::OK")]
252    #[message(resolution = "None.")]
253    ResourcePoweringOn(
254        /// This argument shall contain the name of the relevant Redfish resource.
255        String,
256    ),
257    /// This message shall be used to indicate an aggregation source has been discovered in the network or host.  The `OriginOfCondition` property shall contain a link to the matching `ConnectionMethod` resource if known.
258    #[message(message = "A aggregation source of connection method `%1` located at `%2` has been discovered.")]
259    #[message(id = "ResourceEvent.1.3.0.AggregationSourceDiscovered")]
260    #[message(severity = "crate::models::resource::Health::OK")]
261    #[message(resolution = "The aggregation source is available to the service and can be identified using the identified connection method.")]
262    AggregationSourceDiscovered(
263        /// This argument shall contain a value from the `ConnectionMethodType` enumeration defined in the `ConnectionMethod` schema that describes connection method of the discovered aggregation source.
264        String,
265        /// This argument shall contain the location of the discovered aggregation source, such as an IP address or service entry point.
266        String,
267    ),
268}