xref: /openbmc/bmcweb/features/redfish/include/registries/network_device_message_registry.hpp (revision 56b81992ba8a8e644f2e75251a94df4f4d0d0880) 
1 #pragma once
2 /****************************************************************
3  *                 READ THIS WARNING FIRST
4  * This is an auto-generated header which contains definitions
5  * for Redfish DMTF defined messages.
6  * DO NOT modify this registry outside of running the
7  * parse_registries.py script.  The definitions contained within
8  * this file are owned by DMTF.  Any modifications to these files
9  * should be first pushed to the relevant registry in the DMTF
10  * github organization.
11  ***************************************************************/
12 #include "registries.hpp"
13 
14 #include <array>
15 
16 // clang-format off
17 
18 namespace redfish::registries::network_device
19 {
20 const Header header = {
21     "Copyright 2019-2023 DMTF. All rights reserved.",
22     "#MessageRegistry.v1_6_2.MessageRegistry",
23     1,
24     0,
25     3,
26     "Network Device Message Registry",
27     "en",
28     "This registry defines the messages for networking devices.",
29     "NetworkDevice",
30     "DMTF",
31 };
32 constexpr const char* url =
33     "https://redfish.dmtf.org/registries/NetworkDevice.1.0.3.json";
34 
35 constexpr std::array registry =
36 {
37     MessageEntry{
38         "CableInserted",
39         {
40             "Indicates that a network cable was inserted.",
41             "A network cable was inserted into network adapter '%1' port '%2'.",
42             "OK",
43             2,
44             {
45                 "string",
46                 "string",
47             },
48             "None.",
49         }},
50     MessageEntry{
51         "CableRemoved",
52         {
53             "Indicates that a network cable was removed.",
54             "A cable was removed from network adapter '%1' port '%2'.",
55             "OK",
56             2,
57             {
58                 "string",
59                 "string",
60             },
61             "None.",
62         }},
63     MessageEntry{
64         "ConnectionDropped",
65         {
66             "Indicates that a network connection was dropped.",
67             "The connection is no longer active for network adapter '%1' port '%2' function '%3'.",
68             "OK",
69             3,
70             {
71                 "string",
72                 "string",
73                 "string",
74             },
75             "None.",
76         }},
77     MessageEntry{
78         "ConnectionEstablished",
79         {
80             "Indicates that a network connection was established.",
81             "A network connection was established for network adapter '%1' port '%2' function '%3'.",
82             "OK",
83             3,
84             {
85                 "string",
86                 "string",
87                 "string",
88             },
89             "None.",
90         }},
91     MessageEntry{
92         "DegradedConnectionEstablished",
93         {
94             "Indicates that a network connection was established, but at an unexpectedly low link speed.",
95             "A degraded network connection was established for network adapter '%1' port '%2' function '%3'.",
96             "Warning",
97             3,
98             {
99                 "string",
100                 "string",
101                 "string",
102             },
103             "None.",
104         }},
105     MessageEntry{
106         "LinkFlapDetected",
107         {
108             "Indicates that a network connection is highly unstable.",
109             "The network connection for network adapter '%1' port '%2' function '%3' was established and dropped '%4' times in the last '%5' minutes.",
110             "Warning",
111             5,
112             {
113                 "string",
114                 "string",
115                 "string",
116                 "number",
117                 "number",
118             },
119             "Contact the network administrator for problem resolution.",
120         }},
121 
122 };
123 
124 enum class Index
125 {
126     cableInserted = 0,
127     cableRemoved = 1,
128     connectionDropped = 2,
129     connectionEstablished = 3,
130     degradedConnectionEstablished = 4,
131     linkFlapDetected = 5,
132 };
133 } // namespace redfish::registries::network_device
134