Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Data Structures | |
struct | OPEN_SNMP_COMMUNITY_s |
struct | OPEN_SNMP_TRAP_CONFIG_s |
Macros | |
#define | OPENAPI_SNMP_COMMUNITY_NAME_MAX 21 |
#define | OPENAPI_SNMP_DEFAULT_GROUP_READ_STR "DefaultGroupRead" |
default group read | |
#define | OPENAPI_SNMP_DEFAULT_GROUP_WRITE_STR "DefaultGroupWrite" |
default group write | |
#define | OPENAPI_SNMP_DEFAULT_READ_STR "DefaultRead" |
default RO read community | |
#define | OPENAPI_SNMP_DEFAULT_SUPER_STR "DefaultSuper" |
default SU Super community | |
#define | OPENAPI_SNMP_DEFAULT_VIEW_STR "Default" |
default view name | |
#define | OPENAPI_SNMP_DEFAULT_WRITE_STR "DefaultWrite" |
default RW write community | |
#define | OPENAPI_SNMP_INDEX_NOT_FOUND -1 |
#define | OPENAPI_SNMP_SECURITY_MODEL_SNMPV1_STR "snmpv1" |
security model name | |
#define | OPENAPI_SNMP_SECURITY_MODEL_SNMPV2C_STR "snmpv2c" |
security model name | |
#define | OPENAPI_SNMP_TAG_LIST_INFORM_NOTIFY_STR "InformNotify" |
Inform tag list. | |
#define | OPENAPI_SNMP_TAG_LIST_TRAP_NOTIFY_STR "TrapNotify" |
Common string names. More... | |
#define | OPENAPI_SNMP_UDP_IPV4_DOMAIN_STR "snmpUDPDomain" |
IPv4 domain. | |
#define | OPENAPI_SNMP_UDP_IPV6_DOMAIN_STR "transportDomainUdpIpv6" |
IPv6 domain. | |
Typedefs | |
typedef struct OPEN_SNMP_COMMUNITY_s | OPEN_SNMP_COMMUNITY_t |
typedef struct OPEN_SNMP_TRAP_CONFIG_s | OPEN_SNMP_TRAP_CONFIG_t |
Functions | |
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. More... | |
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 supported. More... | |
open_error_t | openapiSnmpCommunityAndIPAddrGet (openapiClientHandle_t *client_handle, open_buffdesc *communityName, OPEN_SNMP_COMMUNITY_t *community) |
Gets an existing SNMP community. More... | |
open_error_t | openapiSnmpCommunityAndIPAddrGetNext (openapiClientHandle_t *client_handle, open_buffdesc *communityName, open_buffdesc *nextCommunityName) |
Retrieve the next SNMP community entry based on community name. More... | |
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. More... | |
open_error_t | openapiSnmpCommunityDelete (openapiClientHandle_t *client_handle, open_buffdesc *communityName) |
Delete an existing SNMP community entry and related securityToGroup entries and target tags. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
open_error_t | openapiSnmpLocalEngineIdDelete (openapiClientHandle_t *client_handle) |
Delete the SNMP engine id on the local device. More... | |
open_error_t | openapiSnmpLocalEngineIdGet (openapiClientHandle_t *client_handle, open_buffdesc *engineId) |
Get the SNMP engine id on the local device. More... | |
open_error_t | openapiSnmpLocalEngineIdSet (openapiClientHandle_t *client_handle, open_buffdesc *engineId) |
Set the SNMP engine id on the local device. More... | |
open_error_t | openapiSnmpSysContactGet (openapiClientHandle_t *client_handle, open_buffdesc *sysContact) |
Get the system contact information. More... | |
open_error_t | openapiSnmpSysContactSet (openapiClientHandle_t *client_handle, open_buffdesc *sysContact) |
Set the SNMP system contact. More... | |
open_error_t | openapiSnmpSysLocationGet (openapiClientHandle_t *client_handle, open_buffdesc *sysLocation) |
Get the system location information. More... | |
open_error_t | openapiSnmpSysLocationSet (openapiClientHandle_t *client_handle, open_buffdesc *sysLocation) |
Set the SNMP system location. More... | |
open_error_t | openapiSnmpSysNameGet (openapiClientHandle_t *client_handle, open_buffdesc *sysName) |
Get the system name. More... | |
open_error_t | openapiSnmpSysNameSet (openapiClientHandle_t *client_handle, open_buffdesc *sysName) |
Set the SNMP system name. More... | |
open_error_t | openapiSnmpTrapFlagGet (openapiClientHandle_t *client_handle, uint32_t trapFlag, bool *mode) |
Retrieve the trap mode for a single trap. More... | |
open_error_t | openapiSnmpTrapFlagSet (openapiClientHandle_t *client_handle, uint32_t trapFlags, bool mode) |
Enable or disable the traps identified via the trapFlags selection. More... | |
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. More... | |
open_error_t | openapiSnmpTrapSrcIntfSet (openapiClientHandle_t *client_handle, uint32_t intf) |
Set the source interface which SNMP trap originates. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
#define OPENAPI_SNMP_TAG_LIST_TRAP_NOTIFY_STR "TrapNotify" |
SNMP Community access types.
Enumerator | |
---|---|
OPEN_SNMP_COMMUNITY_ACCESS_NONE |
Not specified. |
OPEN_SNMP_COMMUNITY_ACCESS_RO |
Read-only type. |
OPEN_SNMP_COMMUNITY_ACCESS_RW |
Read-write type. |
OPEN_SNMP_COMMUNITY_ACCESS_SU |
Super-user type. |
Definition at line 62 of file openapi_snmp.h.
Message processing model, typically the SNMP version.
Definition at line 114 of file openapi_snmp.h.
Exclusion value of the vacmFilterViewTreeFamilyType MIB object.
Enumerator | |
---|---|
OPEN_SNMP_NOTIFY_FILTER_TYPE_INCLUDED |
Included in the MIB view. |
OPEN_SNMP_NOTIFY_FILTER_TYPE_EXCLUDED |
Excluded from the MIB view. |
Definition at line 130 of file openapi_snmp.h.
SNMP Notification types.
Enumerator | |
---|---|
OPEN_SNMP_NOTIFY_TYPE_TRAP |
Unacknowledged trap type. |
OPEN_SNMP_NOTIFY_TYPE_INFORM |
Acknowledged trap type. |
Definition at line 71 of file openapi_snmp.h.
SNMPV3 Security levels.
Definition at line 106 of file openapi_snmp.h.
Security model id.
Enumerator | |
---|---|
OPEN_SNMP_SECURITY_MODEL_ANY |
Any version. |
OPEN_SNMP_SECURITY_MODEL_SNMPV1 |
SNMP v1. |
OPEN_SNMP_SECURITY_MODEL_SNMPV2C |
SNMP V2c. |
OPEN_SNMP_SECURITY_MODEL_USM |
User-Based Security Model. |
Definition at line 97 of file openapi_snmp.h.
Supported SNMP trap flags.
Definition at line 145 of file openapi_snmp.h.
Used to identify tree family type MIB.
Enumerator | |
---|---|
OPEN_SNMP_VIEW_TREE |
VACM view tree family. |
OPEN_SNMP_FILTER_TREE |
VACM filter tree family. |
Definition at line 137 of file openapi_snmp.h.
Exclusion value of the vacmViewTreeFamilyType MIB object.
Enumerator | |
---|---|
OPEN_SNMP_VIEW_TYPE_INCLUDED |
Included in the MIB view. |
OPEN_SNMP_VIEW_TYPE_EXCLUDED |
Excluded from the MIB view. |
Definition at line 123 of file openapi_snmp.h.
User-Based Security Model Authentication protocols.
Enumerator | |
---|---|
OPEN_USM_USER_AUTH_PROTOCOL_NONE |
Not specified. |
OPEN_USM_USER_AUTH_PROTOCOL_SHA |
Secure Hash Algorithm. |
OPEN_USM_USER_AUTH_PROTOCOL_MD5 |
Message Digest Algorithm. |
Definition at line 78 of file openapi_snmp.h.
User-Based Security Model Privilege protocols.
Definition at line 86 of file openapi_snmp.h.
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.
If the community name already exists, the entry is modifed with the new parameters.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
[in] | community | community parameters |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | The set request is invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FULL | Community table is full |
OPEN_E_UNAVAIL | SNMP feature or SNMP config API is not supported on this platform. |
OpEN API Version: 1.19
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 supported.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
OPEN_E_NONE | Delete is successful |
OPEN_E_FAIL | Delete failed |
OPEN_E_ERROR | The delete request is invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature or SNMP config API is not supported on this platform. |
OpEN API Version: 1.19
open_error_t openapiSnmpCommunityAndIPAddrGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | communityName, | ||
OPEN_SNMP_COMMUNITY_t * | community | ||
) |
Gets an existing SNMP community.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
[out] | community | community parameters |
OPEN_E_NONE | Get successful |
OPEN_E_FAIL | Get failed |
OPEN_E_ERROR | The get request is invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature or SNMP config API is not supported on this platform. |
OpEN API Version: 1.19
open_error_t openapiSnmpCommunityAndIPAddrGetNext | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | communityName, | ||
open_buffdesc * | nextCommunityName | ||
) |
Retrieve the next SNMP community entry based on community name.
Calling this function with an initialized communityName fetches the first community entry. Iterative calls while replacing communityName with the next values continues to loop through the communities until the end of the list.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
[out] | nextCommunityName | next community name |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.19
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.
If the community name already exists, the entry is first deleted along with any related securityToGroup entries and/or target tags.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
- | Minimum value OPENAPI_SNMP_COMMUNITY_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_COMMUNITY_NAME_MAX | |
[in] | accessType | optional community access |
[in] | viewName | optional view name |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[out] | addr | optional IPv4 address, for allowed access |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiSnmpCommunityDelete | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | communityName | ||
) |
Delete an existing SNMP community entry and related securityToGroup entries and target tags.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
- | Minimum value OPENAPI_SNMP_COMMUNITY_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_COMMUNITY_NAME_MAX |
OPEN_E_NONE | Delete is successful |
OPEN_E_FAIL | Delete failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
Calling this function with an initialized communityName fetches the first community entry. Iterative calls while replacing communityName with the next values continues to loop through the communities until the end of the list.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
- | Minimum value OPENAPI_SNMP_COMMUNITY_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_COMMUNITY_NAME_MAX | |
[out] | accessType | optional community access |
[out] | viewName | optional view name |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[out] | addr | optional IPv4 address, for allowed access |
[out] | nextCommunityName | next community name |
- | Minimum value OPENAPI_SNMP_COMMUNITY_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_COMMUNITY_NAME_MAX |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
- | Minimum value OPENAPI_SNMP_COMMUNITY_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_COMMUNITY_NAME_MAX | |
[in] | groupName | group name |
- | Minimum value OPENAPI_SNMP_GROUP_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_GROUP_NAME_MAX | |
[in] | addr | optional IPv4 address, for allowed access |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
If the filter already exists, the associated MIBS (vacmFilterTreeFamilySubtree and vacmFilterTreeFamilyMask) are updated according to the filterType flag.
[in] | client_handle | client handle from registration API |
[in] | filterName | filter name |
- | Minimum value OPENAPI_SNMP_FILTER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_FILTER_NAME_MAX | |
[in] | oidTree | ASN.1 subtree OID to be included/excluded from the filter |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX | |
[in] | filterType | included or excluded from the MIB filter |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
If the oidTree is omitted, all views matching the filterName will be deleted.
[in] | client_handle | client handle from registration API |
[in] | filterName | filter name |
- | Minimum value OPENAPI_SNMP_FILTER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_FILTER_NAME_MAX | |
[in] | oidTree | optional ASN.1 subtree OID to be included/excluded from the view |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX |
OPEN_E_NONE | Delete is successful |
OPEN_E_FAIL | Delete failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
Calling this function with an initialized filter name and oidTree fetches the first filter entry. Iterative calls while replacing filterName and oidTree with the next values continues to loop through the filters until the end of the list.
[in] | client_handle | client handle from registration API |
[in] | filterName | filter name |
- | Minimum value OPENAPI_SNMP_FILTER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_FILTER_NAME_MAX | |
[in] | oidTree | ASN.1 subtree OID to be included/excluded from the filter |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX | |
[out] | filterType | included or excluded from the MIB filter |
[out] | nextFilterName | next filter name |
- | Minimum value OPENAPI_SNMP_FILTER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_FILTER_NAME_MAX | |
[out] | nextOidTree | next ASN.1 subtree OID to be included/excluded from the filter |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | groupName | group name |
- | Minimum value OPENAPI_SNMP_GROUP_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_GROUP_NAME_MAX | |
[in] | securityModel | version number |
[in] | securityLevel | security level (valid only for securityModel OPEN_SNMP_SECURITY_MODEL_USM) |
[in] | contextPrefix | optional prefix name to associate the group with |
- | Minimum value OPENAPI_SNMP_CONTEXT_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_CONTEXT_NAME_MAX | |
[in] | readView | optional, enables user to view the contents of the agent |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[in] | writeView | optional, enables user to enter data and configure the contents of the agent |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[in] | notifyView | optional, enables user to specify an inform or a trap |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_EXISTS | if SNMP group already exists |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | groupName | group name |
- | Minimum value OPENAPI_SNMP_GROUP_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_GROUP_NAME_MAX | |
[in] | securityModel | version number |
[in] | securityLevel | security level (valid only for securityModel OPEN_SNMP_SECURITY_MODEL_USM) |
[in] | contextPrefix | optional prefix name to associate the group with |
- | Minimum value OPENAPI_SNMP_CONTEXT_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_CONTEXT_NAME_MAX |
OPEN_E_NONE | Delete is successful |
OPEN_E_FAIL | Delete failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
Calling this function with the control parameters; groupName, securityModel, securityLevel, and contextPrefix initialized fetches the first group entry. Iterative calls while replacing the control parameters with the next group values continue to loop through the groups until the end of the list.
[in] | client_handle | client handle from registration API |
[in] | groupName | group name |
- | Minimum value OPENAPI_SNMP_GROUP_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_GROUP_NAME_MAX | |
[in,out] | securityModel | version number |
[in,out] | securityLevel | security level (valid only for securityModel OPEN_SNMP_SECURITY_MODEL_USM) |
[in] | contextPrefix | prefix name to associate the group with |
- | Minimum value OPENAPI_SNMP_CONTEXT_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_CONTEXT_NAME_MAX | |
[out] | readView | enables user to view the contents of the agent |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[out] | writeView | enables user to enter data and configure the contents of the agent |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[out] | notifyView | enables user to specify an inform or a trap |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[out] | nextGroupName | next group name |
- | Minimum value OPENAPI_SNMP_GROUP_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_GROUP_NAME_MAX | |
[out] | nextContextPrefix | next prefix name |
- | Minimum value OPENAPI_SNMP_CONTEXT_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_CONTEXT_NAME_MAX |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
This includes the target address object and its various parameters, including an optional notification filter.
[in] | client_handle | client handle from registration API |
[in] | host | IPv4 or IPv6 address |
- | Maximum value OPENAPI_SNMP_HOST_NAME_MAX | |
[in] | serverPort | optional host receiver port number. |
- | Default value OPENAPI_SNMP_SERVER_PORT_DEF | |
- | Minimum value OPENAPI_SNMP_SERVER_PORT_MIN | |
- | Maximum value OPENAPI_SNMP_SERVER_PORT_MAX | |
[in] | securityName | context name (community or user name) |
- | Minimum value OPENAPI_SNMP_CONTEXT_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_CONTEXT_NAME_MAX | |
[in] | securityModel | version number |
[in] | securityLevel | security level |
[in] | notifyType | notification type |
[in] | timeout | optional timeout in milliseconds for OPEN_SNMP_NOTIFY_TYPE_INFORM trap type |
- | Maximum value OPENAPI_SNMP_TIMEOUT_COUNT_MAX | |
[in] | retries | optional retries for OPEN_SNMP_NOTIFY_TYPE_INFORM trap type |
- | Maximum value OPENAPI_SNMP_RETRIES_COUNT_MAX | |
[in] | filter | optional notification filter name |
- | Maximum value OPENAPI_SNMP_FILTER_NAME_MAX |
OPEN_E_NONE | Set is successful |
OPEN_E_FAIL | Set failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_EXISTS | if host already exists |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | strHost | IPv4 or IPv6 address |
[in] | notifyType | notification type |
- | Maximum value OPENAPI_SNMP_HOST_NAME_MAX |
OPEN_E_NONE | Delete is successful |
OPEN_E_FAIL | Delete failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
Calling this function with an initialized host fetches the first host entry. Iterative calls while replacing host with nextHost continues to loop through the host entries until the end of the list.
[in] | client_handle | client handle from registration API |
[in] | host | IPv4 or IPv6 address |
- | Maximum value OPENAPI_SNMP_HOST_NAME_MAX | |
[out] | serverPort | optional host receiver port number. |
[out] | securityName | context name (community or user name) |
- | Minimum value OPENAPI_SNMP_CONTEXT_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_CONTEXT_NAME_MAX | |
[out] | securityModel | version number |
[out] | securityLevel | security level |
[out] | notifyType | notification type |
[out] | timeout | optional timeout in milliseconds for OPEN_SNMP_NOTIFY_TYPE_INFORM trap type |
[out] | retries | optional retries for OPEN_SNMP_NOTIFY_TYPE_INFORM trap type |
[out] | filter | optional notification filter name |
- | Minimum value OPENAPI_SNMP_FILTER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_FILTER_NAME_MAX | |
[out] | nextHost | next host |
- | Maximum value OPENAPI_SNMP_HOST_NAME_MAX |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiSnmpLocalEngineIdDelete | ( | openapiClientHandle_t * | client_handle | ) |
Delete the SNMP engine id on the local device.
The engine id is actually reset to the default id which is automatically generated based on the local MAC address.
[in] | client_handle | client handle from registration API |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiSnmpLocalEngineIdGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | engineId | ||
) |
Get the SNMP engine id on the local device.
[in] | client_handle | client handle from registration API |
[out] | engineId | local engine id |
- | Minimum value OPENAPI_SNMP_ENGINE_ID_MIN | |
- | Maximum value OPENAPI_SNMP_ENGINE_ID_MAX |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiSnmpLocalEngineIdSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | engineId | ||
) |
Set the SNMP engine id on the local device.
[in] | client_handle | client handle from registration API |
[in] | engineId | local engine id |
- | Default indicator OPENAPI_SNMP_ENGINE_ID_DEF | |
- | Minimum value OPENAPI_SNMP_ENGINE_ID_MIN | |
- | Maximum value OPENAPI_SNMP_ENGINE_ID_MAX |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiSnmpSysContactGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sysContact | ||
) |
Get the system contact information.
[in] | client_handle | client handle from registration API |
[out] | sysContact | system contact |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiSnmpSysContactSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sysContact | ||
) |
Set the SNMP system contact.
The textual identification of the contact person for this managed node, together with information on how to contact this person.
[in] | client_handle | client handle from registration API |
[in] | sysContact | system contact |
- | Minimum value 1 | |
- | Maximum value OPENAPI_SNMP_SYSTEM_CONTACT_MAX |
OPEN_E_NONE | Set is successful |
OPEN_E_FAIL | Set failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OpEN API Version: 1.2
open_error_t openapiSnmpSysLocationGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sysLocation | ||
) |
Get the system location information.
[in] | client_handle | client handle from registration API |
[out] | sysLocation | system location |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiSnmpSysLocationSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sysLocation | ||
) |
Set the SNMP system location.
The physical location of this node, for example; 'telephone closet' or '3rd floor'.
[in] | client_handle | client handle from registration API |
[in] | sysLocation | system location |
- | Minimum value 1 | |
- | Maximum value OPENAPI_SNMP_SYSTEM_LOCATION_MAX |
OPEN_E_NONE | Set is successful |
OPEN_E_FAIL | Set failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OpEN API Version: 1.2
open_error_t openapiSnmpSysNameGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sysName | ||
) |
Get the system name.
[in] | client_handle | client handle from registration API |
[out] | sysName | system name |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
open_error_t openapiSnmpSysNameSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sysName | ||
) |
Set the SNMP system name.
An administratively-assigned name for this managed node. By convention, this is the node's fully-qualified domain name.
[in] | client_handle | client handle from registration API |
[in] | sysName | system name |
- | Minimum value 1 | |
- | Maximum value OPENAPI_SNMP_SYSTEM_NAME_MAX |
OPEN_E_NONE | Set is successful |
OPEN_E_FAIL | Set failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OpEN API Version: 1.2
open_error_t openapiSnmpTrapFlagGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | trapFlag, | ||
bool * | mode | ||
) |
Retrieve the trap mode for a single trap.
[in] | client_handle | client handle from registration API |
[in] | trapFlag | selected trap from OPEN_SNMP_TRAP_FLAGS_t |
[out] | mode | Set on or off |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiSnmpTrapFlagSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | trapFlags, | ||
bool | mode | ||
) |
Enable or disable the traps identified via the trapFlags selection.
[in] | client_handle | client handle from registration API |
[in] | trapFlags | selected traps, a bitmask of OPEN_SNMP_TRAP_FLAGS_t |
[in] | mode | Set on or off |
OPEN_E_NONE | Set is successful |
OPEN_E_FAIL | Set failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_UNAVAIL | If one or more trap sets failed due to the feature availability. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.2
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.
Trap receivers with an enabled status are active and the SNMP agent sends traps to them with source IP address as source-interface address.
[in] | client_handle | client handle from registration API |
[out] | intf | source interface (internal interface number) |
[out] | type | interface type |
[out] | addr | IP address of interface |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
open_error_t openapiSnmpTrapSrcIntfSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf | ||
) |
Set the source interface which SNMP trap originates.
Trap receivers with an enabled status are active and the SNMP agent sends traps to them with source IP address as source-interface address.
[in] | client_handle | client handle from registration API |
[in] | intf | source interface (internal interface number) from which source IP is used by the SNMP Trap client |
OPEN_E_NONE | Set is successful |
OPEN_E_FAIL | Set failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
The first attempt is to convert the oid/mask to a prefix string. If that fails, an attempt is made to convert the OID directly to a prefix string. If that fails, then simply return the oidTree.
[in] | client_handle | client handle from registration API |
[in] | name | view or filter name |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN or OPENAPI_SNMP_FILTER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX or OPENAPI_SNMP_FILTER_NAME_MAX | |
[in] | oidTree | OID to translate (in various forms) |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX | |
[in] | treeType | view or filter |
[out] | oidString | converted OID |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
Essentially, convert the prefix of the given OID into a decimal OID, leaving the rest of the OID intact. Then check if the oid is supported at the SNMP level. Any asterisks '*' in the OID is replaced with a 0.
[in] | client_handle | client handle from registration API |
[in] | name | view or filter name |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN or OPENAPI_SNMP_FILTER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX or OPENAPI_SNMP_FILTER_NAME_MAX | |
[in] | oidTree | OID to translate (in various forms) |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX | |
[in] | treeType | view or filter |
[out] | oidVal | converted OID |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
This function first validates the input parameters by checking their content and ranges. The user name and engine id combination is then checked to be unique. If so, then the user name, engine id, authorization, privilege, and group is set.
[in] | client_handle | client handle from registration API |
[in] | userName | user name |
- | Minimum value OPENAPI_SNMP_USER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_USER_NAME_MAX | |
[in] | groupName | group name |
- | Minimum value OPENAPI_SNMP_GROUP_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_GROUP_NAME_MAX | |
[in] | authProto | authentication protocol type |
[in] | authPwd | HMAC-MD5-96 or HMAC-SHA-96 authentication password |
- | Minimum value OPENAPI_SNMP_AUTH_PWD_MIN | |
- | Maximum value OPENAPI_SNMP_AUTH_PWD_MAX | |
[in] | authKey | pre-generated key |
- | HMAC-MD5-96 key size OPENAPI_SNMP_MD5_KEY_SIZE | |
- | HMAC-SHA-96 key size OPENAPI_SNMP_SHA_KEY_SIZE | |
[in] | privProto | privilege protocol type |
[in] | privPwd | CBC-DES symmetric encryption password |
- | Minimum value OPENAPI_SNMP_AUTH_PWD_MIN | |
- | Maximum value OPENAPI_SNMP_AUTH_PWD_MAX | |
[in] | privKey | pre-generated key |
- | HMAC-MD5-96 key size OPENAPI_SNMP_MD5_KEY_SIZE | |
[in] | engineId | remote engine id |
- | Minimum value OPENAPI_SNMP_ENGINE_ID_MIN | |
- | Maximum value OPENAPI_SNMP_ENGINE_ID_MAX |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_EXISTS | if userName and engineId already exists |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | userName | user name |
- | Minimum value OPENAPI_SNMP_USER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_USER_NAME_MAX | |
[in] | engineId | remote engine id |
- | Minimum value OPENAPI_SNMP_ENGINE_ID_MIN | |
- | Maximum value OPENAPI_SNMP_ENGINE_ID_MAX |
OPEN_E_NONE | Delete is successful |
OPEN_E_FAIL | Delete failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
Calling this function with an initialized userName and engineId fetches the first user entry. Iterative calls while replacing userName and engineId with their next values continues to loop through the user entries until the end of the list.
[in] | client_handle | client handle from registration API |
[in] | userName | user name |
- | Minimum value OPENAPI_SNMP_USER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_USER_NAME_MAX | |
[in] | engineId | remote engine id |
- | Minimum value OPENAPI_SNMP_ENGINE_ID_MIN | |
- | Maximum value OPENAPI_SNMP_ENGINE_ID_MAX | |
[out] | groupName | group name |
- | Minimum value OPENAPI_SNMP_GROUP_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_GROUP_NAME_MAX | |
[out] | authProto | authentication protocol type |
[out] | authKey | pre-generated key |
[out] | privProto | privilege protocol type |
[out] | nextUserName | next user name |
- | Minimum value OPENAPI_SNMP_USER_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_USER_NAME_MAX | |
[out] | nextEngineId | next remote engine id |
- | Minimum value OPENAPI_SNMP_ENGINE_ID_MIN | |
- | Maximum value OPENAPI_SNMP_ENGINE_ID_MAX |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
If the view name already exists, the associated MIBS (vacmViewTreeFamilySubtree and vacmViewTreeFamilyMask) are updated according to the viewType flag.
[in] | client_handle | client handle from registration API |
[in] | viewName | view name |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[in] | oidTree | ASN.1 subtree OID to be included/excluded from the view |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX | |
[in] | viewType | included or excluded from the MIB view |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
If the oidTree is omitted, all views matching the viewName will be deleted.
[in] | client_handle | client handle from registration API |
[in] | viewName | view name |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[in] | oidTree | optional ASN.1 subtree OID to be included/excluded from the view |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX |
OPEN_E_NONE | Delete is successful |
OPEN_E_FAIL | Delete failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
Calling this function with an initialized view name and oidTree fetches the first view entry. Iterative calls while replacing viewName and oidTree with the next values continues to loop through the views until the end of the list.
[in] | client_handle | client handle from registration API |
[in] | viewName | view name |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[in] | oidTree | ASN.1 subtree OID to be included/excluded from the view |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX | |
[out] | viewType | included or excluded from the MIB view |
[out] | nextViewName | next view name |
- | Minimum value OPENAPI_SNMP_VIEW_NAME_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_NAME_MAX | |
[out] | nextOidTree | next ASN.1 subtree OID to be included/excluded from the view |
- | Minimum value OPENAPI_SNMP_VIEW_TREE_MIN | |
- | Maximum value OPENAPI_SNMP_VIEW_TREE_MAX |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | SNMP feature is not supported on this platform. |
OpEN API Version: 1.2
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.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
[in] | ipAddr | community IP address |
[out] | nextCommunityName | next community name |
OPEN_E_NONE | Get successful |
OPEN_E_FAIL | Get failed |
OPEN_E_ERROR | if the set request was invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature or SNMP config API is not supported on this platform. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
[in] | ipAddr | community IP address |
[in] | trapConfig | trap configuration |
OPEN_E_NONE | Create is successful |
OPEN_E_FAIL | Create failed |
OPEN_E_ERROR | The set request invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FULL | Trap manager table is full |
OPEN_E_UNAVAIL | SNMP feature or SNMP config API is not supported on this platform. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
[in] | ipAddr | community IP address |
OPEN_E_NONE | Delete is successful |
OPEN_E_FAIL | Delete failed |
OPEN_E_ERROR | The delete request is invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature or SNMP config API is not supported on this platform. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
[in] | ipAddr | community IP address |
[out] | trapConfig | Trap configuration |
OPEN_E_NONE | Get successful |
OPEN_E_FAIL | Get failed |
OPEN_E_ERROR | The get request is invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature or SNMP config API is not supported on this platform. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | communityName | community name |
[in] | ipAddr | community IP address |
[out] | nextIPAddr | next IP address |
OPEN_E_NONE | Get successful |
OPEN_E_FAIL | Get failed |
OPEN_E_ERROR | The set request is invalid |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_UNAVAIL | SNMP feature or SNMP config API is not supported on this platform. |
OpEN API Version: 1.19