Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_snmp.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2016-2020 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 ***********************************************************************
26 *
27 * @filename openapi_snmp.h
28 *
29 * @purpose Simple Network Management Protocol (SNMP) Configuration
30 *
31 * @component OPEN
32 *
33 * @create 09/20/2013
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_SNMP_H_INCLUDED
39 #define OPENAPI_SNMP_H_INCLUDED
40 
41 #include <stdbool.h>
42 #include "openapi_common.h"
43 
45 #define OPENAPI_SNMP_TAG_LIST_TRAP_NOTIFY_STR "TrapNotify"
46 #define OPENAPI_SNMP_TAG_LIST_INFORM_NOTIFY_STR "InformNotify"
47 #define OPENAPI_SNMP_UDP_IPV4_DOMAIN_STR "snmpUDPDomain"
48 #define OPENAPI_SNMP_UDP_IPV6_DOMAIN_STR "transportDomainUdpIpv6"
49 #define OPENAPI_SNMP_SECURITY_MODEL_SNMPV1_STR "snmpv1"
50 #define OPENAPI_SNMP_SECURITY_MODEL_SNMPV2C_STR "snmpv2c"
51 #define OPENAPI_SNMP_DEFAULT_GROUP_READ_STR "DefaultGroupRead"
52 #define OPENAPI_SNMP_DEFAULT_GROUP_WRITE_STR "DefaultGroupWrite"
53 #define OPENAPI_SNMP_DEFAULT_READ_STR "DefaultRead"
54 #define OPENAPI_SNMP_DEFAULT_WRITE_STR "DefaultWrite"
55 #define OPENAPI_SNMP_DEFAULT_SUPER_STR "DefaultSuper"
56 #define OPENAPI_SNMP_DEFAULT_VIEW_STR "Default"
58 #define OPENAPI_SNMP_INDEX_NOT_FOUND -1
59 #define OPENAPI_SNMP_COMMUNITY_NAME_MAX 21
60 
62 typedef enum
63 {
64  OPEN_SNMP_COMMUNITY_ACCESS_NONE = 0,
65  OPEN_SNMP_COMMUNITY_ACCESS_RO = 1,
66  OPEN_SNMP_COMMUNITY_ACCESS_RW = 2,
67  OPEN_SNMP_COMMUNITY_ACCESS_SU = 3
68 } OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t;
69 
71 typedef enum
72 {
73  OPEN_SNMP_NOTIFY_TYPE_TRAP = 1,
74  OPEN_SNMP_NOTIFY_TYPE_INFORM = 2
75 } OPEN_SNMP_NOTIFY_TYPE_t;
76 
78 typedef enum
79 {
80  OPEN_USM_USER_AUTH_PROTOCOL_NONE = 0,
81  OPEN_USM_USER_AUTH_PROTOCOL_SHA = 1,
82  OPEN_USM_USER_AUTH_PROTOCOL_MD5 = 2
83 } OPEN_USM_USER_AUTH_PROTOCOL_t;
84 
86 typedef enum
87 {
88  OPEN_USM_USER_PRIV_PROTOCOL_NONE = 0,
89  OPEN_USM_USER_PRIV_PROTOCOL_DES = 1,
90  OPEN_USM_USER_PRIV_PROTOCOL_3DES = 2,
91  OPEN_USM_USER_PRIV_PROTOCOL_AES128 = 3,
92  OPEN_USM_USER_PRIV_PROTOCOL_AES192 = 4,
93  OPEN_USM_USER_PRIV_PROTOCOL_AES256 = 5
94 } OPEN_USM_USER_PRIV_PROTOCOL_t;
95 
97 typedef enum
98 {
99  OPEN_SNMP_SECURITY_MODEL_ANY = 0,
100  OPEN_SNMP_SECURITY_MODEL_SNMPV1 = 1,
101  OPEN_SNMP_SECURITY_MODEL_SNMPV2C = 2,
102  OPEN_SNMP_SECURITY_MODEL_USM = 3
103 } OPEN_SNMP_SECURITY_MODEL_t;
104 
106 typedef enum
107 {
108  OPEN_SNMP_SECURITY_LEVEL_NOAUTHNOPRIV = 1,
109  OPEN_SNMP_SECURITY_LEVEL_AUTHNOPRIV = 2,
110  OPEN_SNMP_SECURITY_LEVEL_AUTHPRIV = 3
111 } OPEN_SNMP_SECURITY_LEVEL_t;
112 
114 typedef enum
115 {
116  OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV1 = 0,
117  OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV2C = 1,
118  OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV2U = 2,
119  OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV3 = 3
120 } OPEN_SNMP_MESSAGE_PROCESSING_MODEL_t;
121 
123 typedef enum
124 {
125  OPEN_SNMP_VIEW_TYPE_INCLUDED = 1,
126  OPEN_SNMP_VIEW_TYPE_EXCLUDED = 2
127 } OPEN_SNMP_VIEW_TYPE_t;
128 
130 typedef enum
131 {
132  OPEN_SNMP_NOTIFY_FILTER_TYPE_INCLUDED = 1,
133  OPEN_SNMP_NOTIFY_FILTER_TYPE_EXCLUDED = 2
134 } OPEN_SNMP_NOTIFY_FILTER_TYPE_t;
135 
137 typedef enum
138 {
139  OPEN_SNMP_VIEW_TREE = 1,
140  OPEN_SNMP_FILTER_TREE = 2
141 } OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t;
142 
143 
145 typedef enum
146 {
147  OPEN_SNMP_ACL_TRAP_FLAG = 1,
148  OPEN_SNMP_BOXS_FAN_STATUS_TRAP_FLAG = 2,
149  OPEN_SNMP_BOXS_POWER_STATUS_TRAP_FLAG = 4,
150  OPEN_SNMP_BOXS_TEMP_STATUS_TRAP_FLAG = 8,
151  OPEN_SNMP_BGP_TRAP_FLAG = 16,
152  OPEN_SNMP_LINK_MODE_TRAP_FLAG = 32,
153  OPEN_SNMP_MULTI_USERS_TRAP_FLAG = 64,
154  OPEN_SNMP_OSPFV2_TRAP_FLAG = 128,
155  OPEN_SNMP_OSPFV3_TRAP_FLAG = 256,
156  OPEN_SNMP_STP_MODE_TRAP_FLAG = 512,
157  OPEN_SNMP_USER_AUTH_TRAP_FLAG = 1024,
158  OPEN_SNMP_VIOLATION_TRAP_FLAG = 2048
159 } OPEN_SNMP_TRAP_FLAGS_t;
160 
161 typedef enum
162 {
163  OPEN_SNMP_COMMUNITY_STATUS_VALID = 1,
164  OPEN_SNMP_COMMUNITY_STATUS_INVALID = 2,
165  OPEN_SNMP_COMMUNITY_STATUS_DELETE = 3,
166  OPEN_SNMP_COMMUNITY_STATUS_CONFIG = 4
167 } OPEN_SNMP_COMMUNITY_STATUS_t;
168 
169 typedef enum
170 {
171  OPEN_SNMP_TRAP_VER_NONE = 1,
172  OPEN_SNMP_TRAP_VER_SNMPV1 = 2,
173  OPEN_SNMP_TRAP_VER_SNMPV2C = 3
174 }OPEN_SNMP_TRAP_VERSION_t;
175 
176 typedef struct OPEN_SNMP_COMMUNITY_s
177 {
178  OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t type; /* Community Access Type */
179  open_inet_addr_t ipAddr; /* IPv4 address (optional) */
180  open_inet_addr_t ipMask; /* IPv4 address mask (optional) */
181  OPEN_SNMP_COMMUNITY_STATUS_t status; /* Community Status */
182 }OPEN_SNMP_COMMUNITY_t;
183 
184 typedef struct OPEN_SNMP_TRAP_CONFIG_s
185 {
186  OPEN_SNMP_TRAP_VERSION_t version;
187  OPEN_SNMP_COMMUNITY_STATUS_t status;
188 }OPEN_SNMP_TRAP_CONFIG_t;
189 
190 /*************************************************************************/
218 open_error_t openapiSnmpCommunityCreate(openapiClientHandle_t *client_handle,
219  open_buffdesc *communityName,
220  OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t accessType,
221  open_buffdesc *viewName,
222  open_inet_addr_t addr);
223 
224 /*************************************************************************/
244 open_error_t openapiSnmpCommunityDelete(openapiClientHandle_t *client_handle,
245  open_buffdesc *communityName);
246 
247 /*************************************************************************/
275 open_error_t openapiSnmpCommunityGetNext(openapiClientHandle_t *client_handle,
276  open_buffdesc *communityName,
277  OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t *accessType,
278  open_buffdesc *viewName,
279  open_inet_addr_t *addr,
280  open_buffdesc *nextCommunityName);
281 
282 /*************************************************************************/
308 open_error_t openapiSnmpCommunityGroupCreate(openapiClientHandle_t *client_handle,
309  open_buffdesc *communityName,
310  open_buffdesc *groupName,
311  open_inet_addr_t addr);
312 
313 /*************************************************************************/
339 open_error_t openapiSnmpFilterCreate(openapiClientHandle_t *client_handle,
340  open_buffdesc *filterName,
341  open_buffdesc *oidTree,
342  OPEN_SNMP_NOTIFY_FILTER_TYPE_t filterType);
343 
344 /*************************************************************************/
368 open_error_t openapiSnmpFilterDelete(openapiClientHandle_t *client_handle,
369  open_buffdesc *filterName,
370  open_buffdesc *oidTree);
371 
372 /*************************************************************************/
403 open_error_t openapiSnmpFilterGetNext(openapiClientHandle_t *client_handle,
404  open_buffdesc *filterName,
405  open_buffdesc *oidTree,
406  OPEN_SNMP_NOTIFY_FILTER_TYPE_t *filterType,
407  open_buffdesc *nextFilterName,
408  open_buffdesc *nextOidTree);
409 
410 /*************************************************************************/
445 open_error_t openapiSnmpGroupCreate(openapiClientHandle_t *client_handle,
446  open_buffdesc *groupName,
447  OPEN_SNMP_SECURITY_MODEL_t securityModel,
448  OPEN_SNMP_SECURITY_LEVEL_t securityLevel,
449  open_buffdesc *contextPrefix,
450  open_buffdesc *readView,
451  open_buffdesc *writeView,
452  open_buffdesc *notifyView);
453 
454 /*************************************************************************/
479 open_error_t openapiSnmpGroupDelete(openapiClientHandle_t *client_handle,
480  open_buffdesc *groupName,
481  OPEN_SNMP_SECURITY_MODEL_t securityModel,
482  OPEN_SNMP_SECURITY_LEVEL_t securityLevel,
483  open_buffdesc *contextPrefix);
484 
485 /*************************************************************************/
527 open_error_t openapiSnmpGroupGetNext(openapiClientHandle_t *client_handle,
528  open_buffdesc *groupName,
529  OPEN_SNMP_SECURITY_MODEL_t *securityModel,
530  OPEN_SNMP_SECURITY_LEVEL_t *securityLevel,
531  open_buffdesc *contextPrefix,
532  open_buffdesc *readView,
533  open_buffdesc *writeView,
534  open_buffdesc *notifyView,
535  open_buffdesc *nextGroupName,
536  open_buffdesc *nextContextPrefix);
537 
538 /*************************************************************************/
556 open_error_t openapiSnmpLocalEngineIdDelete(openapiClientHandle_t *client_handle);
557 
558 /*************************************************************************/
575 open_error_t openapiSnmpLocalEngineIdGet(openapiClientHandle_t *client_handle,
576  open_buffdesc *engineId);
577 
578 /*************************************************************************/
602 open_error_t openapiSnmpLocalEngineIdSet(openapiClientHandle_t *client_handle,
603  open_buffdesc *engineId);
604 
605 /*************************************************************************/
651 open_error_t openapiSnmpUserCreate(openapiClientHandle_t *client_handle,
652  open_buffdesc *userName,
653  open_buffdesc *groupName,
654  OPEN_USM_USER_AUTH_PROTOCOL_t authProto,
655  open_buffdesc *authPwd,
656  open_buffdesc *authKey,
657  OPEN_USM_USER_PRIV_PROTOCOL_t privProto,
658  open_buffdesc *privPwd,
659  open_buffdesc *privKey,
660  open_buffdesc *engineId);
661 
662 /*************************************************************************/
687 open_error_t openapiSnmpUserDelete(openapiClientHandle_t *client_handle,
688  open_buffdesc *userName,
689  open_buffdesc *engineId);
690 
691 /*************************************************************************/
727 open_error_t openapiSnmpUserGetNext(openapiClientHandle_t *client_handle,
728  open_buffdesc *userName,
729  open_buffdesc *engineId,
730  open_buffdesc *groupName,
731  OPEN_USM_USER_AUTH_PROTOCOL_t *authProto,
732  OPEN_USM_USER_PRIV_PROTOCOL_t *privProto,
733  open_buffdesc *nextUserName,
734  open_buffdesc *nextEngineId);
735 
736 /*************************************************************************/
773 open_error_t openapiSnmpHostCreate(openapiClientHandle_t *client_handle,
774  open_buffdesc *host,
775  uint32_t serverPort,
776  open_buffdesc *securityName,
777  OPEN_SNMP_SECURITY_MODEL_t securityModel,
778  OPEN_SNMP_SECURITY_LEVEL_t securityLevel,
779  OPEN_SNMP_NOTIFY_TYPE_t notifyType,
780  uint32_t timeout,
781  uint32_t retries,
782  open_buffdesc *filter);
783 
784 /*************************************************************************/
803 open_error_t openapiSnmpHostDelete(openapiClientHandle_t *client_handle,
804  open_buffdesc *host,
805  OPEN_SNMP_NOTIFY_TYPE_t notifyType);
806 
807 /*************************************************************************/
840 open_error_t openapiSnmpHostGetNext(openapiClientHandle_t *client_handle,
841  open_buffdesc *host,
842  uint32_t *serverPort,
843  open_buffdesc *securityName,
844  OPEN_SNMP_SECURITY_MODEL_t *securityModel,
845  OPEN_SNMP_SECURITY_LEVEL_t *securityLevel,
846  OPEN_SNMP_NOTIFY_TYPE_t *notifyType,
847  uint32_t *timeout,
848  uint32_t *retries,
849  open_buffdesc *filter,
850  open_buffdesc *nextHost);
851 
852 /*************************************************************************/
868 open_error_t openapiSnmpTrapFlagGet(openapiClientHandle_t *client_handle,
869  uint32_t trapFlag,
870  bool *mode);
871 
872 /*************************************************************************/
895 open_error_t openapiSnmpTrapFlagSet(openapiClientHandle_t *client_handle,
896  uint32_t trapFlags,
897  bool mode);
898 
899 /*************************************************************************/
919 open_error_t openapiSnmpTrapSrcIntfGet(openapiClientHandle_t *client_handle,
920  uint32_t *intf,
921  OPEN_INTF_TYPE_t *type,
922  open_inet_addr_t *addr);
923 
924 /*************************************************************************/
945 open_error_t openapiSnmpTrapSrcIntfSet(openapiClientHandle_t *client_handle,
946  uint32_t intf);
947 
948 /*************************************************************************/
974 open_error_t openapiSnmpViewCreate(openapiClientHandle_t *client_handle,
975  open_buffdesc *viewName,
976  open_buffdesc *oidTree,
977  OPEN_SNMP_VIEW_TYPE_t viewType);
978 
979 /*************************************************************************/
1004 open_error_t openapiSnmpViewDelete(openapiClientHandle_t *client_handle,
1005  open_buffdesc *viewName,
1006  open_buffdesc *oidTree);
1007 
1008 /*************************************************************************/
1039 open_error_t openapiSnmpViewGetNext(openapiClientHandle_t *client_handle,
1040  open_buffdesc *viewName,
1041  open_buffdesc *oidTree,
1042  OPEN_SNMP_VIEW_TYPE_t *viewType,
1043  open_buffdesc *nextViewName,
1044  open_buffdesc *nextOidTree);
1045 
1046 /*************************************************************************/
1073 open_error_t openapiSnmpTreeFamilyOidStringGet(openapiClientHandle_t *client_handle,
1074  open_buffdesc *name,
1075  open_buffdesc *oidTree,
1076  OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t treeType,
1077  open_buffdesc *oidString);
1078 
1079 /*************************************************************************/
1107 open_error_t openapiSnmpTreeFamilyOidValGet(openapiClientHandle_t *client_handle,
1108  open_buffdesc *name,
1109  open_buffdesc *oidTree,
1110  OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t treeType,
1111  open_buffdesc *oidVal);
1112 
1113 /*************************************************************************/
1127 open_error_t openapiSnmpSysContactGet(openapiClientHandle_t *client_handle,
1128  open_buffdesc *sysContact);
1129 
1130 /*************************************************************************/
1150 open_error_t openapiSnmpSysContactSet(openapiClientHandle_t *client_handle,
1151  open_buffdesc *sysContact);
1152 
1153 /*************************************************************************/
1167 open_error_t openapiSnmpSysNameGet(openapiClientHandle_t *client_handle,
1168  open_buffdesc *sysName);
1169 
1170 /*************************************************************************/
1190 open_error_t openapiSnmpSysNameSet(openapiClientHandle_t *client_handle,
1191  open_buffdesc *sysName);
1192 
1193 /*************************************************************************/
1207 open_error_t openapiSnmpSysLocationGet(openapiClientHandle_t *client_handle,
1208  open_buffdesc *sysLocation);
1209 
1210 /*************************************************************************/
1229 open_error_t openapiSnmpSysLocationSet(openapiClientHandle_t *client_handle,
1230  open_buffdesc *sysLocation);
1231 
1232 /*************************************************************************/
1254 open_error_t openapiSnmpCommunityAndIPAddrCreate(openapiClientHandle_t *client_handle,
1255  open_buffdesc *communityName,
1256  OPEN_SNMP_COMMUNITY_t community);
1257 
1258 /*************************************************************************/
1277 open_error_t openapiSnmpCommunityAndIPAddrDelete(openapiClientHandle_t *client_handle,
1278  open_buffdesc *communityName);
1279 
1280 /*************************************************************************/
1300 open_error_t openapiSnmpCommunityAndIPAddrGetNext(openapiClientHandle_t *client_handle,
1301  open_buffdesc *communityName,
1302  open_buffdesc *nextCommunityName);
1303 
1304 /*************************************************************************/
1322 open_error_t openapiSnmpCommunityAndIPAddrGet(openapiClientHandle_t *client_handle,
1323  open_buffdesc *communityName,
1324  OPEN_SNMP_COMMUNITY_t *community);
1325 
1326 /*************************************************************************/
1347 open_error_t openapiTrapManagerConfigCreate(openapiClientHandle_t *client_handle,
1348  open_buffdesc *communityName,
1349  open_inet_addr_t ipAddr,
1350  OPEN_SNMP_TRAP_CONFIG_t trapConfig);
1351 
1352 /*************************************************************************/
1372 open_error_t openapiTrapManagerConfigDelete(openapiClientHandle_t *client_handle,
1373  open_buffdesc *communityName,
1374  open_inet_addr_t ipAddr);
1375 
1376 /*************************************************************************/
1395 open_error_t openapiTrapManagerConfigGet(openapiClientHandle_t *client_handle,
1396  open_buffdesc *communityName,
1397  open_inet_addr_t ipAddr,
1398  OPEN_SNMP_TRAP_CONFIG_t *trapConfig);
1399 
1400 /*************************************************************************/
1419 open_error_t openapiTrapManagerConfigCommunityGetNext(openapiClientHandle_t *client_handle,
1420  open_buffdesc *communityName,
1421  open_inet_addr_t ipAddr,
1422  open_buffdesc *nextCommunityName);
1423 
1424 /*************************************************************************/
1443 open_error_t openapiTrapManagerConfigIPGetNext(openapiClientHandle_t *client_handle,
1444  open_buffdesc *communityName,
1445  open_inet_addr_t ipAddr,
1446  open_inet_addr_t *nextIPAddr);
1447 
1448 #endif /* OPENAPI_SNMP_H_INCLUDED */
1449