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