Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
openapi_snmp.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2016-2024 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_SHA512 = 3
84 } OPEN_USM_USER_AUTH_PROTOCOL_t;
85 
87 typedef enum
88 {
89  OPEN_USM_USER_PRIV_PROTOCOL_NONE = 0,
90  OPEN_USM_USER_PRIV_PROTOCOL_DES = 1,
91  OPEN_USM_USER_PRIV_PROTOCOL_3DES = 2,
92  OPEN_USM_USER_PRIV_PROTOCOL_AES128 = 3,
93  OPEN_USM_USER_PRIV_PROTOCOL_AES192 = 4,
94  OPEN_USM_USER_PRIV_PROTOCOL_AES256 = 5
95 } OPEN_USM_USER_PRIV_PROTOCOL_t;
96 
98 typedef enum
99 {
100  OPEN_SNMP_SECURITY_MODEL_ANY = 0,
101  OPEN_SNMP_SECURITY_MODEL_SNMPV1 = 1,
102  OPEN_SNMP_SECURITY_MODEL_SNMPV2C = 2,
103  OPEN_SNMP_SECURITY_MODEL_USM = 3
104 } OPEN_SNMP_SECURITY_MODEL_t;
105 
107 typedef enum
108 {
109  OPEN_SNMP_SECURITY_LEVEL_NOAUTHNOPRIV = 1,
110  OPEN_SNMP_SECURITY_LEVEL_AUTHNOPRIV = 2,
111  OPEN_SNMP_SECURITY_LEVEL_AUTHPRIV = 3
112 } OPEN_SNMP_SECURITY_LEVEL_t;
113 
115 typedef enum
116 {
117  OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV1 = 0,
118  OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV2C = 1,
119  OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV2U = 2,
120  OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV3 = 3
121 } OPEN_SNMP_MESSAGE_PROCESSING_MODEL_t;
122 
124 typedef enum
125 {
126  OPEN_SNMP_VIEW_TYPE_INCLUDED = 1,
127  OPEN_SNMP_VIEW_TYPE_EXCLUDED = 2
128 } OPEN_SNMP_VIEW_TYPE_t;
129 
131 typedef enum
132 {
133  OPEN_SNMP_NOTIFY_FILTER_TYPE_INCLUDED = 1,
134  OPEN_SNMP_NOTIFY_FILTER_TYPE_EXCLUDED = 2
135 } OPEN_SNMP_NOTIFY_FILTER_TYPE_t;
136 
138 typedef enum
139 {
140  OPEN_SNMP_VIEW_TREE = 1,
141  OPEN_SNMP_FILTER_TREE = 2
142 } OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t;
143 
144 
146 typedef enum
147 {
148  OPEN_SNMP_ACL_TRAP_FLAG = 1,
149  OPEN_SNMP_BOXS_FAN_STATUS_TRAP_FLAG = 2,
150  OPEN_SNMP_BOXS_POWER_STATUS_TRAP_FLAG = 4,
151  OPEN_SNMP_BOXS_TEMP_STATUS_TRAP_FLAG = 8,
152  OPEN_SNMP_BGP_TRAP_FLAG = 16,
153  OPEN_SNMP_LINK_MODE_TRAP_FLAG = 32,
154  OPEN_SNMP_MULTI_USERS_TRAP_FLAG = 64,
155  OPEN_SNMP_OSPFV2_TRAP_FLAG = 128,
156  OPEN_SNMP_OSPFV3_TRAP_FLAG = 256,
157  OPEN_SNMP_STP_MODE_TRAP_FLAG = 512,
158  OPEN_SNMP_USER_AUTH_TRAP_FLAG = 1024,
159  OPEN_SNMP_VIOLATION_TRAP_FLAG = 2048
160 } OPEN_SNMP_TRAP_FLAGS_t;
161 
162 typedef enum
163 {
164  OPEN_SNMP_COMMUNITY_STATUS_VALID = 1,
165  OPEN_SNMP_COMMUNITY_STATUS_INVALID = 2,
166  OPEN_SNMP_COMMUNITY_STATUS_DELETE = 3,
167  OPEN_SNMP_COMMUNITY_STATUS_CONFIG = 4
168 } OPEN_SNMP_COMMUNITY_STATUS_t;
169 
170 typedef enum
171 {
172  OPEN_SNMP_TRAP_VER_NONE = 1,
173  OPEN_SNMP_TRAP_VER_SNMPV1 = 2,
174  OPEN_SNMP_TRAP_VER_SNMPV2C = 3
175 }OPEN_SNMP_TRAP_VERSION_t;
176 
177 typedef struct OPEN_SNMP_COMMUNITY_s
178 {
179  OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t type; /* Community Access Type */
180  open_inet_addr_t ipAddr; /* IPv4 address (optional) */
181  open_inet_addr_t ipMask; /* IPv4 address mask (optional) */
182  OPEN_SNMP_COMMUNITY_STATUS_t status; /* Community Status */
183  uint32_t ipv6PrefixLen; /* IPv6 address prefix length */
184  unsigned char viewName[31]; /* View name */
185 }OPEN_SNMP_COMMUNITY_t;
186 
187 typedef struct OPEN_SNMP_TRAP_CONFIG_s
188 {
189  OPEN_SNMP_TRAP_VERSION_t version;
190  OPEN_SNMP_COMMUNITY_STATUS_t status;
191 }OPEN_SNMP_TRAP_CONFIG_t;
192 
193 /*************************************************************************/
221 open_error_t openapiSnmpCommunityCreate(openapiClientHandle_t *client_handle,
222  open_buffdesc *communityName,
223  OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t accessType,
224  open_buffdesc *viewName,
225  open_inet_addr_t addr);
226 
227 /*************************************************************************/
247 open_error_t openapiSnmpCommunityDelete(openapiClientHandle_t *client_handle,
248  open_buffdesc *communityName);
249 
250 /*************************************************************************/
278 open_error_t openapiSnmpCommunityGetNext(openapiClientHandle_t *client_handle,
279  open_buffdesc *communityName,
280  OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t *accessType,
281  open_buffdesc *viewName,
282  open_inet_addr_t *addr,
283  open_buffdesc *nextCommunityName);
284 
285 /*************************************************************************/
311 open_error_t openapiSnmpCommunityGroupCreate(openapiClientHandle_t *client_handle,
312  open_buffdesc *communityName,
313  open_buffdesc *groupName,
314  open_inet_addr_t addr);
315 
316 /*************************************************************************/
342 open_error_t openapiSnmpFilterCreate(openapiClientHandle_t *client_handle,
343  open_buffdesc *filterName,
344  open_buffdesc *oidTree,
345  OPEN_SNMP_NOTIFY_FILTER_TYPE_t filterType);
346 
347 /*************************************************************************/
371 open_error_t openapiSnmpFilterDelete(openapiClientHandle_t *client_handle,
372  open_buffdesc *filterName,
373  open_buffdesc *oidTree);
374 
375 /*************************************************************************/
406 open_error_t openapiSnmpFilterGetNext(openapiClientHandle_t *client_handle,
407  open_buffdesc *filterName,
408  open_buffdesc *oidTree,
409  OPEN_SNMP_NOTIFY_FILTER_TYPE_t *filterType,
410  open_buffdesc *nextFilterName,
411  open_buffdesc *nextOidTree);
412 
413 /*************************************************************************/
448 open_error_t openapiSnmpGroupCreate(openapiClientHandle_t *client_handle,
449  open_buffdesc *groupName,
450  OPEN_SNMP_SECURITY_MODEL_t securityModel,
451  OPEN_SNMP_SECURITY_LEVEL_t securityLevel,
452  open_buffdesc *contextPrefix,
453  open_buffdesc *readView,
454  open_buffdesc *writeView,
455  open_buffdesc *notifyView);
456 
457 /*************************************************************************/
482 open_error_t openapiSnmpGroupDelete(openapiClientHandle_t *client_handle,
483  open_buffdesc *groupName,
484  OPEN_SNMP_SECURITY_MODEL_t securityModel,
485  OPEN_SNMP_SECURITY_LEVEL_t securityLevel,
486  open_buffdesc *contextPrefix);
487 
488 /*************************************************************************/
530 open_error_t openapiSnmpGroupGetNext(openapiClientHandle_t *client_handle,
531  open_buffdesc *groupName,
532  OPEN_SNMP_SECURITY_MODEL_t *securityModel,
533  OPEN_SNMP_SECURITY_LEVEL_t *securityLevel,
534  open_buffdesc *contextPrefix,
535  open_buffdesc *readView,
536  open_buffdesc *writeView,
537  open_buffdesc *notifyView,
538  open_buffdesc *nextGroupName,
539  open_buffdesc *nextContextPrefix);
540 
541 /*************************************************************************/
559 open_error_t openapiSnmpLocalEngineIdDelete(openapiClientHandle_t *client_handle);
560 
561 /*************************************************************************/
578 open_error_t openapiSnmpLocalEngineIdGet(openapiClientHandle_t *client_handle,
579  open_buffdesc *engineId);
580 
581 /*************************************************************************/
605 open_error_t openapiSnmpLocalEngineIdSet(openapiClientHandle_t *client_handle,
606  open_buffdesc *engineId);
607 
608 /*************************************************************************/
654 open_error_t openapiSnmpUserCreate(openapiClientHandle_t *client_handle,
655  open_buffdesc *userName,
656  open_buffdesc *groupName,
657  OPEN_USM_USER_AUTH_PROTOCOL_t authProto,
658  open_buffdesc *authPwd,
659  open_buffdesc *authKey,
660  OPEN_USM_USER_PRIV_PROTOCOL_t privProto,
661  open_buffdesc *privPwd,
662  open_buffdesc *privKey,
663  open_buffdesc *engineId);
664 
665 /*************************************************************************/
690 open_error_t openapiSnmpUserDelete(openapiClientHandle_t *client_handle,
691  open_buffdesc *userName,
692  open_buffdesc *engineId);
693 
694 /*************************************************************************/
729 open_error_t openapiSnmpUserGetNext(openapiClientHandle_t *client_handle,
730  open_buffdesc *userName,
731  open_buffdesc *engineId,
732  open_buffdesc *groupName,
733  OPEN_USM_USER_AUTH_PROTOCOL_t *authProto,
734  OPEN_USM_USER_PRIV_PROTOCOL_t *privProto,
735  open_buffdesc *nextUserName,
736  open_buffdesc *nextEngineId);
737 
738 /*************************************************************************/
775 open_error_t openapiSnmpHostCreate(openapiClientHandle_t *client_handle,
776  open_buffdesc *host,
777  uint32_t serverPort,
778  open_buffdesc *securityName,
779  OPEN_SNMP_SECURITY_MODEL_t securityModel,
780  OPEN_SNMP_SECURITY_LEVEL_t securityLevel,
781  OPEN_SNMP_NOTIFY_TYPE_t notifyType,
782  uint32_t timeout,
783  uint32_t retries,
784  open_buffdesc *filter);
785 
786 /*************************************************************************/
805 open_error_t openapiSnmpHostDelete(openapiClientHandle_t *client_handle,
806  open_buffdesc *host,
807  OPEN_SNMP_NOTIFY_TYPE_t notifyType);
808 
809 /*************************************************************************/
842 open_error_t openapiSnmpHostGetNext(openapiClientHandle_t *client_handle,
843  open_buffdesc *host,
844  uint32_t *serverPort,
845  open_buffdesc *securityName,
846  OPEN_SNMP_SECURITY_MODEL_t *securityModel,
847  OPEN_SNMP_SECURITY_LEVEL_t *securityLevel,
848  OPEN_SNMP_NOTIFY_TYPE_t *notifyType,
849  uint32_t *timeout,
850  uint32_t *retries,
851  open_buffdesc *filter,
852  open_buffdesc *nextHost);
853 
854 /*************************************************************************/
870 open_error_t openapiSnmpTrapFlagGet(openapiClientHandle_t *client_handle,
871  uint32_t trapFlag,
872  bool *mode);
873 
874 /*************************************************************************/
897 open_error_t openapiSnmpTrapFlagSet(openapiClientHandle_t *client_handle,
898  uint32_t trapFlags,
899  bool mode);
900 
901 /*************************************************************************/
921 open_error_t openapiSnmpTrapSrcIntfGet(openapiClientHandle_t *client_handle,
922  uint32_t *intf,
923  OPEN_INTF_TYPE_t *type,
924  open_inet_addr_t *addr);
925 
926 /*************************************************************************/
947 open_error_t openapiSnmpTrapSrcIntfSet(openapiClientHandle_t *client_handle,
948  uint32_t intf);
949 
950 /*************************************************************************/
976 open_error_t openapiSnmpViewCreate(openapiClientHandle_t *client_handle,
977  open_buffdesc *viewName,
978  open_buffdesc *oidTree,
979  OPEN_SNMP_VIEW_TYPE_t viewType);
980 
981 /*************************************************************************/
1006 open_error_t openapiSnmpViewDelete(openapiClientHandle_t *client_handle,
1007  open_buffdesc *viewName,
1008  open_buffdesc *oidTree);
1009 
1010 /*************************************************************************/
1041 open_error_t openapiSnmpViewGetNext(openapiClientHandle_t *client_handle,
1042  open_buffdesc *viewName,
1043  open_buffdesc *oidTree,
1044  OPEN_SNMP_VIEW_TYPE_t *viewType,
1045  open_buffdesc *nextViewName,
1046  open_buffdesc *nextOidTree);
1047 
1048 /*************************************************************************/
1075 open_error_t openapiSnmpTreeFamilyOidStringGet(openapiClientHandle_t *client_handle,
1076  open_buffdesc *name,
1077  open_buffdesc *oidTree,
1078  OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t treeType,
1079  open_buffdesc *oidString);
1080 
1081 /*************************************************************************/
1109 open_error_t openapiSnmpTreeFamilyOidValGet(openapiClientHandle_t *client_handle,
1110  open_buffdesc *name,
1111  open_buffdesc *oidTree,
1112  OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t treeType,
1113  open_buffdesc *oidVal);
1114 
1115 /*************************************************************************/
1129 open_error_t openapiSnmpSysContactGet(openapiClientHandle_t *client_handle,
1130  open_buffdesc *sysContact);
1131 
1132 /*************************************************************************/
1152 open_error_t openapiSnmpSysContactSet(openapiClientHandle_t *client_handle,
1153  open_buffdesc *sysContact);
1154 
1155 /*************************************************************************/
1169 open_error_t openapiSnmpSysNameGet(openapiClientHandle_t *client_handle,
1170  open_buffdesc *sysName);
1171 
1172 /*************************************************************************/
1192 open_error_t openapiSnmpSysNameSet(openapiClientHandle_t *client_handle,
1193  open_buffdesc *sysName);
1194 
1195 /*************************************************************************/
1209 open_error_t openapiSnmpSysLocationGet(openapiClientHandle_t *client_handle,
1210  open_buffdesc *sysLocation);
1211 
1212 /*************************************************************************/
1231 open_error_t openapiSnmpSysLocationSet(openapiClientHandle_t *client_handle,
1232  open_buffdesc *sysLocation);
1233 
1234 /*************************************************************************/
1256 open_error_t openapiSnmpCommunityAndIPAddrCreate(openapiClientHandle_t *client_handle,
1257  open_buffdesc *communityName,
1258  OPEN_SNMP_COMMUNITY_t community);
1259 
1260 /*************************************************************************/
1279 open_error_t openapiSnmpCommunityAndIPAddrDelete(openapiClientHandle_t *client_handle,
1280  open_buffdesc *communityName);
1281 
1282 /*************************************************************************/
1302 open_error_t openapiSnmpCommunityAndIPAddrGetNext(openapiClientHandle_t *client_handle,
1303  open_buffdesc *communityName,
1304  open_buffdesc *nextCommunityName);
1305 
1306 /*************************************************************************/
1324 open_error_t openapiSnmpCommunityAndIPAddrGet(openapiClientHandle_t *client_handle,
1325  open_buffdesc *communityName,
1326  OPEN_SNMP_COMMUNITY_t *community);
1327 
1328 /*************************************************************************/
1349 open_error_t openapiTrapManagerConfigCreate(openapiClientHandle_t *client_handle,
1350  open_buffdesc *communityName,
1351  open_inet_addr_t ipAddr,
1352  OPEN_SNMP_TRAP_CONFIG_t trapConfig);
1353 
1354 /*************************************************************************/
1374 open_error_t openapiTrapManagerConfigDelete(openapiClientHandle_t *client_handle,
1375  open_buffdesc *communityName,
1376  open_inet_addr_t ipAddr);
1377 
1378 /*************************************************************************/
1397 open_error_t openapiTrapManagerConfigGet(openapiClientHandle_t *client_handle,
1398  open_buffdesc *communityName,
1399  open_inet_addr_t ipAddr,
1400  OPEN_SNMP_TRAP_CONFIG_t *trapConfig);
1401 
1402 /*************************************************************************/
1421 open_error_t openapiTrapManagerConfigCommunityGetNext(openapiClientHandle_t *client_handle,
1422  open_buffdesc *communityName,
1423  open_inet_addr_t ipAddr,
1424  open_buffdesc *nextCommunityName);
1425 
1426 /*************************************************************************/
1445 open_error_t openapiTrapManagerConfigIPGetNext(openapiClientHandle_t *client_handle,
1446  open_buffdesc *communityName,
1447  open_inet_addr_t ipAddr,
1448  open_inet_addr_t *nextIPAddr);
1449 
1450 /*************************************************************************/
1480 open_error_t openapiSnmpUserConfigGet(openapiClientHandle_t *client_handle,
1481  open_buffdesc *userName,
1482  open_buffdesc *engineId,
1483  open_buffdesc *groupName,
1484  OPEN_USM_USER_AUTH_PROTOCOL_t *authProto,
1485  open_buffdesc *authKey,
1486  OPEN_USM_USER_PRIV_PROTOCOL_t *privProto,
1487  open_buffdesc *privKey);
1488 
1489 /*************************************************************************/
1513 open_error_t openapiSnmpRemoteEngineIdNextGet(openapiClientHandle_t *client_handle,
1514  open_buffdesc *addr,
1515  open_buffdesc *engineId,
1516  open_buffdesc *userName);
1517 
1518 /*************************************************************************/
1540 open_error_t openapiSnmpRemoteEngineIdDelete(openapiClientHandle_t *client_handle,
1541  open_buffdesc *addr,
1542  open_buffdesc *engineId,
1543  open_buffdesc *userName);
1544 
1545 /*************************************************************************/
1567 open_error_t openapiSnmpRemoteEngineIdCreate(openapiClientHandle_t *client_handle,
1568  open_buffdesc *addr,
1569  open_buffdesc *engineId,
1570  open_buffdesc *userName);
1571 
1572 /*************************************************************************/
1617 open_error_t openapiSnmpUserCreateWithRemoteIPAddress(openapiClientHandle_t *client_handle,
1618  open_buffdesc *userName,
1619  open_buffdesc *groupName,
1620  OPEN_USM_USER_AUTH_PROTOCOL_t authProto,
1621  open_buffdesc *authPwd,
1622  open_buffdesc *authKey,
1623  OPEN_USM_USER_PRIV_PROTOCOL_t privProto,
1624  open_buffdesc *privPwd,
1625  open_buffdesc *privKey,
1626  open_buffdesc *remoteIpAddress);
1627 
1628 /*************************************************************************/
1651 open_error_t openapiSnmpUserDeleteWithRemoteIPAddress(openapiClientHandle_t *client_handle,
1652  open_buffdesc *userName,
1653  open_buffdesc *remoteIpAddress);
1654 
1655 /*************************************************************************/
1678 open_error_t openapiSnmpUserRemoteIpAddressGet(openapiClientHandle_t *client_handle,
1679  open_buffdesc *userName,
1680  open_buffdesc *engineId,
1681  open_buffdesc *remoteIpAddress);
1682 #endif /* OPENAPI_SNMP_H_INCLUDED */
1683 
openapiSnmpCommunityCreate
open_error_t openapiSnmpCommunityCreate(openapiClientHandle_t *client_handle, open_buffdesc *communityName, OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t accessType, open_buffdesc *viewName, open_inet_addr_t addr)
Create a new, or edit an existing SNMP community.
OPEN_SNMP_NOTIFY_TYPE_TRAP
Unacknowledged trap type.
Definition: openapi_snmp.h:73
openapiTrapManagerConfigIPGetNext
open_error_t openapiTrapManagerConfigIPGetNext(openapiClientHandle_t *client_handle, open_buffdesc *communityName, open_inet_addr_t ipAddr, open_inet_addr_t *nextIPAddr)
Get next IP address SNMP Trap information.
openapiSnmpGroupGetNext
open_error_t openapiSnmpGroupGetNext(openapiClientHandle_t *client_handle, open_buffdesc *groupName, OPEN_SNMP_SECURITY_MODEL_t *securityModel, OPEN_SNMP_SECURITY_LEVEL_t *securityLevel, open_buffdesc *contextPrefix, open_buffdesc *readView, open_buffdesc *writeView, open_buffdesc *notifyView, open_buffdesc *nextGroupName, open_buffdesc *nextContextPrefix)
Retrieve the next SNMP group entry based on group name.
OPEN_SNMP_NOTIFY_TYPE_INFORM
Acknowledged trap type.
Definition: openapi_snmp.h:74
OPEN_USM_USER_PRIV_PROTOCOL_3DES
Not supported.
Definition: openapi_snmp.h:91
OPEN_SNMP_COMMUNITY_ACCESS_SU
Super-user type.
Definition: openapi_snmp.h:67
OPEN_SNMP_COMMUNITY_ACCESS_RW
Read-write type.
Definition: openapi_snmp.h:66
openapiSnmpViewCreate
open_error_t openapiSnmpViewCreate(openapiClientHandle_t *client_handle, open_buffdesc *viewName, open_buffdesc *oidTree, OPEN_SNMP_VIEW_TYPE_t viewType)
Create a new, or edit an existing SNMP view.
openapiSnmpFilterGetNext
open_error_t openapiSnmpFilterGetNext(openapiClientHandle_t *client_handle, open_buffdesc *filterName, open_buffdesc *oidTree, OPEN_SNMP_NOTIFY_FILTER_TYPE_t *filterType, open_buffdesc *nextFilterName, open_buffdesc *nextOidTree)
Retrieve the next SNMP filter entry based on filter name and oidTree.
openapiSnmpSysNameGet
open_error_t openapiSnmpSysNameGet(openapiClientHandle_t *client_handle, open_buffdesc *sysName)
Get the system name.
OPEN_SNMP_FILTER_TREE
VACM filter tree family.
Definition: openapi_snmp.h:141
OPEN_SNMP_SECURITY_MODEL_t
OPEN_SNMP_SECURITY_MODEL_t
Security model id.
Definition: openapi_snmp.h:98
OPEN_SNMP_BOXS_POWER_STATUS_TRAP_FLAG
Power supply status traps.
Definition: openapi_snmp.h:150
OPEN_SNMP_COMMUNITY_s
Definition: openapi_snmp.h:177
OPEN_USM_USER_PRIV_PROTOCOL_AES256
Not supported.
Definition: openapi_snmp.h:94
openapiSnmpUserCreateWithRemoteIPAddress
open_error_t openapiSnmpUserCreateWithRemoteIPAddress(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *groupName, OPEN_USM_USER_AUTH_PROTOCOL_t authProto, open_buffdesc *authPwd, open_buffdesc *authKey, OPEN_USM_USER_PRIV_PROTOCOL_t privProto, open_buffdesc *privPwd, open_buffdesc *privKey, open_buffdesc *remoteIpAddress)
Create a new SNMP user entry.
openapiSnmpGroupDelete
open_error_t openapiSnmpGroupDelete(openapiClientHandle_t *client_handle, open_buffdesc *groupName, OPEN_SNMP_SECURITY_MODEL_t securityModel, OPEN_SNMP_SECURITY_LEVEL_t securityLevel, open_buffdesc *contextPrefix)
Delete an existing SNMP group.
openapiSnmpCommunityGetNext
open_error_t openapiSnmpCommunityGetNext(openapiClientHandle_t *client_handle, open_buffdesc *communityName, OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t *accessType, open_buffdesc *viewName, open_inet_addr_t *addr, open_buffdesc *nextCommunityName)
Retrieve the next SNMP community entry based on community name.
openapiSnmpTrapFlagSet
open_error_t openapiSnmpTrapFlagSet(openapiClientHandle_t *client_handle, uint32_t trapFlags, bool mode)
Enable or disable the traps identified via the trapFlags selection.
OPEN_SNMP_VIEW_TREE
VACM view tree family.
Definition: openapi_snmp.h:140
openapiSnmpUserDelete
open_error_t openapiSnmpUserDelete(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *engineId)
Delete an existing SNMP user name entry with a matching engine id.
openapiSnmpRemoteEngineIdCreate
open_error_t openapiSnmpRemoteEngineIdCreate(openapiClientHandle_t *client_handle, open_buffdesc *addr, open_buffdesc *engineId, open_buffdesc *userName)
Create the SNMP Remote IP Address and Engine ID entry.
OPEN_SNMP_SECURITY_MODEL_ANY
Any version.
Definition: openapi_snmp.h:100
OPEN_SNMP_VIEW_TYPE_EXCLUDED
Excluded from the MIB view.
Definition: openapi_snmp.h:127
openapiSnmpFilterCreate
open_error_t openapiSnmpFilterCreate(openapiClientHandle_t *client_handle, open_buffdesc *filterName, open_buffdesc *oidTree, OPEN_SNMP_NOTIFY_FILTER_TYPE_t filterType)
Create a new, or edit an existing SNMP filter entry.
OPEN_SNMP_VIOLATION_TRAP_FLAG
All interfaces for Port MAC locking security violations.
Definition: openapi_snmp.h:159
OPEN_SNMP_BOXS_TEMP_STATUS_TRAP_FLAG
Temperature status traps.
Definition: openapi_snmp.h:151
openapiSnmpRemoteEngineIdDelete
open_error_t openapiSnmpRemoteEngineIdDelete(openapiClientHandle_t *client_handle, open_buffdesc *addr, open_buffdesc *engineId, open_buffdesc *userName)
Delete the SNMP Remote IP Address and Engine ID entry.
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiSnmpSysNameSet
open_error_t openapiSnmpSysNameSet(openapiClientHandle_t *client_handle, open_buffdesc *sysName)
Set the SNMP system name.
OPEN_USM_USER_PRIV_PROTOCOL_NONE
Not specified.
Definition: openapi_snmp.h:89
openapiSnmpSysContactGet
open_error_t openapiSnmpSysContactGet(openapiClientHandle_t *client_handle, open_buffdesc *sysContact)
Get the system contact information.
OPEN_SNMP_SECURITY_LEVEL_AUTHNOPRIV
Communication with authentication and without privacy.
Definition: openapi_snmp.h:110
openapiSnmpSysLocationGet
open_error_t openapiSnmpSysLocationGet(openapiClientHandle_t *client_handle, open_buffdesc *sysLocation)
Get the system location information.
OPEN_USM_USER_AUTH_PROTOCOL_SHA512
SHA512.
Definition: openapi_snmp.h:83
openapiSnmpLocalEngineIdGet
open_error_t openapiSnmpLocalEngineIdGet(openapiClientHandle_t *client_handle, open_buffdesc *engineId)
Get the SNMP engine id on the local device.
OPEN_INTF_TYPE_t
OPEN_INTF_TYPE_t
Definition: openapi_common.h:201
openapiSnmpHostDelete
open_error_t openapiSnmpHostDelete(openapiClientHandle_t *client_handle, open_buffdesc *host, OPEN_SNMP_NOTIFY_TYPE_t notifyType)
Delete an existing SNMPv1/2 or v3 host entry.
OPEN_SNMP_SECURITY_MODEL_SNMPV1
SNMP v1.
Definition: openapi_snmp.h:101
OPEN_USM_USER_AUTH_PROTOCOL_SHA
Secure Hash Algorithm.
Definition: openapi_snmp.h:81
OPEN_SNMP_SECURITY_LEVEL_t
OPEN_SNMP_SECURITY_LEVEL_t
SNMPV3 Security levels.
Definition: openapi_snmp.h:107
open_buffdesc
Definition: openapi_common.h:138
OPEN_SNMP_MESSAGE_PROCESSING_MODEL_t
OPEN_SNMP_MESSAGE_PROCESSING_MODEL_t
Message processing model, typically the SNMP version.
Definition: openapi_snmp.h:115
OPEN_SNMP_TRAP_CONFIG_s
Definition: openapi_snmp.h:187
openapiClientHandle_s
Definition: openapi_common.h:131
openapiSnmpLocalEngineIdSet
open_error_t openapiSnmpLocalEngineIdSet(openapiClientHandle_t *client_handle, open_buffdesc *engineId)
Set the SNMP engine id on the local device.
OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t
OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t
Used to identify tree family type MIB.
Definition: openapi_snmp.h:138
OPEN_SNMP_SECURITY_LEVEL_AUTHPRIV
Communication with authentication and privacy.
Definition: openapi_snmp.h:111
OPEN_SNMP_NOTIFY_FILTER_TYPE_INCLUDED
Included in the MIB view.
Definition: openapi_snmp.h:133
OPEN_SNMP_VIEW_TYPE_t
OPEN_SNMP_VIEW_TYPE_t
Exclusion value of the vacmViewTreeFamilyType MIB object.
Definition: openapi_snmp.h:124
OPEN_SNMP_VIEW_TYPE_INCLUDED
Included in the MIB view.
Definition: openapi_snmp.h:126
OPEN_SNMP_OSPFV3_TRAP_FLAG
All available OSPFv3 traps.
Definition: openapi_snmp.h:156
OPEN_SNMP_MULTI_USERS_TRAP_FLAG
When multiple logins are active.
Definition: openapi_snmp.h:154
OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV3
SNMP V3.
Definition: openapi_snmp.h:120
openapiSnmpUserConfigGet
open_error_t openapiSnmpUserConfigGet(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *engineId, open_buffdesc *groupName, OPEN_USM_USER_AUTH_PROTOCOL_t *authProto, open_buffdesc *authKey, OPEN_USM_USER_PRIV_PROTOCOL_t *privProto, open_buffdesc *privKey)
Retrieve the authentication protocol, authentication key, encryption protocol and encryption key for ...
OPEN_USM_USER_PRIV_PROTOCOL_AES128
Advanced Encryption Standard 128 protocol.
Definition: openapi_snmp.h:92
openapiSnmpFilterDelete
open_error_t openapiSnmpFilterDelete(openapiClientHandle_t *client_handle, open_buffdesc *filterName, open_buffdesc *oidTree)
Delete an existing SNMP filter entry based on the filterName and optionally the oidTree.
OPEN_SNMP_NOTIFY_FILTER_TYPE_t
OPEN_SNMP_NOTIFY_FILTER_TYPE_t
Exclusion value of the vacmFilterViewTreeFamilyType MIB object.
Definition: openapi_snmp.h:131
openapiSnmpTreeFamilyOidValGet
open_error_t openapiSnmpTreeFamilyOidValGet(openapiClientHandle_t *client_handle, open_buffdesc *name, open_buffdesc *oidTree, OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t treeType, open_buffdesc *oidVal)
Get the actual OID value for the given view or filter.
OPEN_USM_USER_PRIV_PROTOCOL_AES192
Not supported.
Definition: openapi_snmp.h:93
openapiSnmpSysLocationSet
open_error_t openapiSnmpSysLocationSet(openapiClientHandle_t *client_handle, open_buffdesc *sysLocation)
Set the SNMP system location.
openapiSnmpRemoteEngineIdNextGet
open_error_t openapiSnmpRemoteEngineIdNextGet(openapiClientHandle_t *client_handle, open_buffdesc *addr, open_buffdesc *engineId, open_buffdesc *userName)
Gets the next SNMP Remote IP Address and Engine ID entry.
OPEN_SNMP_COMMUNITY_ACCESS_NONE
Not specified.
Definition: openapi_snmp.h:64
OPEN_SNMP_SECURITY_LEVEL_NOAUTHNOPRIV
Communication without authentication and privacy.
Definition: openapi_snmp.h:109
OPEN_USM_USER_PRIV_PROTOCOL_t
OPEN_USM_USER_PRIV_PROTOCOL_t
User-Based Security Model Privilege protocols.
Definition: openapi_snmp.h:87
OPEN_USM_USER_PRIV_PROTOCOL_DES
Data Encryption Standard protocol.
Definition: openapi_snmp.h:90
openapiSnmpLocalEngineIdDelete
open_error_t openapiSnmpLocalEngineIdDelete(openapiClientHandle_t *client_handle)
Delete the SNMP engine id on the local device.
openapiSnmpViewDelete
open_error_t openapiSnmpViewDelete(openapiClientHandle_t *client_handle, open_buffdesc *viewName, open_buffdesc *oidTree)
Delete an existing SNMP view entry based on the viewName and optionally the oidTree.
openapiSnmpCommunityDelete
open_error_t openapiSnmpCommunityDelete(openapiClientHandle_t *client_handle, open_buffdesc *communityName)
Delete an existing SNMP community entry and related securityToGroup entries and target tags...
openapiSnmpTrapFlagGet
open_error_t openapiSnmpTrapFlagGet(openapiClientHandle_t *client_handle, uint32_t trapFlag, bool *mode)
Retrieve the trap mode for a single trap.
openapiSnmpCommunityAndIPAddrDelete
open_error_t openapiSnmpCommunityAndIPAddrDelete(openapiClientHandle_t *client_handle, open_buffdesc *communityName)
Delete an existing SNMP community entry and related securityToGroup entries if SNMP config API is not...
openapiSnmpCommunityAndIPAddrCreate
open_error_t openapiSnmpCommunityAndIPAddrCreate(openapiClientHandle_t *client_handle, open_buffdesc *communityName, OPEN_SNMP_COMMUNITY_t community)
Create a new, or edit an existing SNMP community.
OPEN_SNMP_BOXS_FAN_STATUS_TRAP_FLAG
Fan status traps.
Definition: openapi_snmp.h:149
OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV2U
SNMP V2 user-based.
Definition: openapi_snmp.h:119
openapiSnmpTreeFamilyOidStringGet
open_error_t openapiSnmpTreeFamilyOidStringGet(openapiClientHandle_t *client_handle, open_buffdesc *name, open_buffdesc *oidTree, OPEN_SNMP_VACM_TREE_FAMILY_TYPE_t treeType, open_buffdesc *oidString)
Get the translated string representation of an OID for the given view or filter.
openapiTrapManagerConfigCreate
open_error_t openapiTrapManagerConfigCreate(openapiClientHandle_t *client_handle, open_buffdesc *communityName, open_inet_addr_t ipAddr, OPEN_SNMP_TRAP_CONFIG_t trapConfig)
Create a new, or edit an existing SNMP Trap entry.
openapiSnmpCommunityAndIPAddrGetNext
open_error_t openapiSnmpCommunityAndIPAddrGetNext(openapiClientHandle_t *client_handle, open_buffdesc *communityName, open_buffdesc *nextCommunityName)
Retrieve the next SNMP community entry based on community name.
openapiSnmpUserRemoteIpAddressGet
open_error_t openapiSnmpUserRemoteIpAddressGet(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *engineId, open_buffdesc *remoteIpAddress)
Retrieve the Remote IP address for the specified SNMPv3 user and engine ID.
openapiSnmpTrapSrcIntfGet
open_error_t openapiSnmpTrapSrcIntfGet(openapiClientHandle_t *client_handle, uint32_t *intf, OPEN_INTF_TYPE_t *type, open_inet_addr_t *addr)
Get the source interface which SNMP trap originates.
OPEN_SNMP_ACL_TRAP_FLAG
User authentication traps.
Definition: openapi_snmp.h:148
OPEN_SNMP_LINK_MODE_TRAP_FLAG
Switch level link up/down traps.
Definition: openapi_snmp.h:153
OPEN_USM_USER_AUTH_PROTOCOL_NONE
Not specified.
Definition: openapi_snmp.h:80
openapiSnmpHostCreate
open_error_t openapiSnmpHostCreate(openapiClientHandle_t *client_handle, open_buffdesc *host, uint32_t serverPort, open_buffdesc *securityName, OPEN_SNMP_SECURITY_MODEL_t securityModel, OPEN_SNMP_SECURITY_LEVEL_t securityLevel, OPEN_SNMP_NOTIFY_TYPE_t notifyType, uint32_t timeout, uint32_t retries, open_buffdesc *filter)
Create an SNMPv1/2 or v3 host.
OPEN_USM_USER_AUTH_PROTOCOL_t
OPEN_USM_USER_AUTH_PROTOCOL_t
User-Based Security Model Authentication protocols.
Definition: openapi_snmp.h:78
OPEN_SNMP_COMMUNITY_ACCESS_RO
Read-only type.
Definition: openapi_snmp.h:65
OPEN_SNMP_SECURITY_MODEL_USM
User-Based Security Model.
Definition: openapi_snmp.h:103
OPEN_USM_USER_AUTH_PROTOCOL_MD5
Message Digest Algorithm.
Definition: openapi_snmp.h:82
openapiTrapManagerConfigCommunityGetNext
open_error_t openapiTrapManagerConfigCommunityGetNext(openapiClientHandle_t *client_handle, open_buffdesc *communityName, open_inet_addr_t ipAddr, open_buffdesc *nextCommunityName)
Get next community SNMP Trap information.
openapi_common.h
openapiSnmpViewGetNext
open_error_t openapiSnmpViewGetNext(openapiClientHandle_t *client_handle, open_buffdesc *viewName, open_buffdesc *oidTree, OPEN_SNMP_VIEW_TYPE_t *viewType, open_buffdesc *nextViewName, open_buffdesc *nextOidTree)
Retrieve the next SNMP view entry based on view name and oidTree.
OPEN_SNMP_TRAP_FLAGS_t
OPEN_SNMP_TRAP_FLAGS_t
Supported SNMP trap flags.
Definition: openapi_snmp.h:146
openapiSnmpCommunityAndIPAddrGet
open_error_t openapiSnmpCommunityAndIPAddrGet(openapiClientHandle_t *client_handle, open_buffdesc *communityName, OPEN_SNMP_COMMUNITY_t *community)
Gets an existing SNMP community.
OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t
OPEN_SNMP_COMMUNITY_ACCESS_TYPE_t
SNMP Community access types.
Definition: openapi_snmp.h:62
openapiSnmpUserDeleteWithRemoteIPAddress
open_error_t openapiSnmpUserDeleteWithRemoteIPAddress(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *remoteIpAddress)
Delete an existing SNMP user name entry with a matching Remote IP address.
openapiSnmpSysContactSet
open_error_t openapiSnmpSysContactSet(openapiClientHandle_t *client_handle, open_buffdesc *sysContact)
Set the SNMP system contact.
openapiSnmpTrapSrcIntfSet
open_error_t openapiSnmpTrapSrcIntfSet(openapiClientHandle_t *client_handle, uint32_t intf)
Set the source interface which SNMP trap originates.
OPEN_SNMP_NOTIFY_TYPE_t
OPEN_SNMP_NOTIFY_TYPE_t
SNMP Notification types.
Definition: openapi_snmp.h:71
OPEN_SNMP_USER_AUTH_TRAP_FLAG
User authentication traps.
Definition: openapi_snmp.h:158
OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV1
SNMP V1.
Definition: openapi_snmp.h:117
openapiTrapManagerConfigGet
open_error_t openapiTrapManagerConfigGet(openapiClientHandle_t *client_handle, open_buffdesc *communityName, open_inet_addr_t ipAddr, OPEN_SNMP_TRAP_CONFIG_t *trapConfig)
Get SNMP Trap information.
openapiSnmpUserGetNext
open_error_t openapiSnmpUserGetNext(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *engineId, open_buffdesc *groupName, OPEN_USM_USER_AUTH_PROTOCOL_t *authProto, OPEN_USM_USER_PRIV_PROTOCOL_t *privProto, open_buffdesc *nextUserName, open_buffdesc *nextEngineId)
Retrieve the next SNMP user entry based on user name and engine id.
openapiSnmpGroupCreate
open_error_t openapiSnmpGroupCreate(openapiClientHandle_t *client_handle, open_buffdesc *groupName, OPEN_SNMP_SECURITY_MODEL_t securityModel, OPEN_SNMP_SECURITY_LEVEL_t securityLevel, open_buffdesc *contextPrefix, open_buffdesc *readView, open_buffdesc *writeView, open_buffdesc *notifyView)
Create a new SNMP group.
OPEN_SNMP_OSPFV2_TRAP_FLAG
All available OSPFv2 traps.
Definition: openapi_snmp.h:155
OPEN_SNMP_NOTIFY_FILTER_TYPE_EXCLUDED
Excluded from the MIB view.
Definition: openapi_snmp.h:134
OPEN_SNMP_STP_MODE_TRAP_FLAG
Spanning Tree traps.
Definition: openapi_snmp.h:157
openapiTrapManagerConfigDelete
open_error_t openapiTrapManagerConfigDelete(openapiClientHandle_t *client_handle, open_buffdesc *communityName, open_inet_addr_t ipAddr)
Deletes an existing SNMP Trap entry and related entries if SNMP config API is not supported...
openapiSnmpCommunityGroupCreate
open_error_t openapiSnmpCommunityGroupCreate(openapiClientHandle_t *client_handle, open_buffdesc *communityName, open_buffdesc *groupName, open_inet_addr_t addr)
Map a new internal security name for SNMP v1 and SNMP v2 security models to an existing group name...
open_inet_addr_s
Definition: openapi_common.h:310
openapiSnmpUserCreate
open_error_t openapiSnmpUserCreate(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *groupName, OPEN_USM_USER_AUTH_PROTOCOL_t authProto, open_buffdesc *authPwd, open_buffdesc *authKey, OPEN_USM_USER_PRIV_PROTOCOL_t privProto, open_buffdesc *privPwd, open_buffdesc *privKey, open_buffdesc *engineId)
Create a new SNMP user entry.
openapiSnmpHostGetNext
open_error_t openapiSnmpHostGetNext(openapiClientHandle_t *client_handle, open_buffdesc *host, uint32_t *serverPort, open_buffdesc *securityName, OPEN_SNMP_SECURITY_MODEL_t *securityModel, OPEN_SNMP_SECURITY_LEVEL_t *securityLevel, OPEN_SNMP_NOTIFY_TYPE_t *notifyType, uint32_t *timeout, uint32_t *retries, open_buffdesc *filter, open_buffdesc *nextHost)
Retrieve the next SNMPv1/2 or v3 host based on host IP address.
OPEN_SNMP_MESSAGE_PROCESSING_MODEL_SNMPV2C
SNMP V2 community-based.
Definition: openapi_snmp.h:118
OPEN_SNMP_BGP_TRAP_FLAG
All available BGP traps.
Definition: openapi_snmp.h:152
OPEN_SNMP_SECURITY_MODEL_SNMPV2C
SNMP V2c.
Definition: openapi_snmp.h:102