Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Functions | |
open_error_t | openapiDhcpSnoopingAdminModeGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, OPEN_CONTROL_t *adminMode) |
Gets the DHCP Snooping Admin mode. More... | |
open_error_t | openapiDhcpSnoopingDbFileNameGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, open_buffdesc *fileName) |
Get the remote DHCP snooping database file name. More... | |
open_error_t | openapiDhcpSnoopingDbFileNameMaxLengthGet (openapiClientHandle_t *client_handle, uint32_t *len) |
Get the remote DHCP snooping database file name max length. More... | |
open_error_t | openapiDhcpSnoopingDbIpAddressGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, open_inet_addr_t *addr) |
Get the remote DHCP snooping database IPv4 Address. More... | |
open_error_t | openapiDhcpSnoopingDbWriteDelayGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t *delay) |
Get the DHCP snooping database write delay. More... | |
open_error_t | openapiDhcpSnoopingEnabledVlanRangeNextGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t *vlanStart, uint32_t *vlanEnd) |
Given a VLAN ID, return the endpoints of the next range of VLANs enabled for DHCP snooping. More... | |
open_error_t | openapiDhcpSnoopingIntfLoggedGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t ifNum, OPEN_BOOL_t *logged) |
Determines whether DHCP snooping logs invalid packets on an interface. More... | |
open_error_t | openapiDhcpSnoopingIntfTrustedGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t ifNum, OPEN_BOOL_t *trusted) |
Determines whether DHCP snooping considers an interface as trusted. More... | |
open_error_t | openapiDhcpSnoopingPortEnabledGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, uint32_t ifNum, OPEN_CONTROL_t *enabled) |
Determines whether DHCP snooping is enabled on a port. More... | |
open_error_t | openapiDhcpSnoopingVerifySourceMacGet (openapiClientHandle_t *client_handle, OPEN_AF_t family, OPEN_CONTROL_t *sourceMacVerify) |
Gets whether DHCP snooping verifies source MAC addresses. More... | |
open_error_t openapiDhcpSnoopingAdminModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | family, | ||
OPEN_CONTROL_t * | adminMode | ||
) |
Gets the DHCP Snooping Admin mode.
[in] | client_handle | Client handle from registration API |
[in] | family | OPEN_AF_INET or OPEN_AF_INET6 |
[out] | adminMode | DHCP snooping admin mode |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_FAIL | On failure |
OPEN_E_UNAVAIL | IPv6 requested but support is unavailable |
OpEN API Version: 1.18
open_error_t openapiDhcpSnoopingDbFileNameGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | family, | ||
open_buffdesc * | fileName | ||
) |
Get the remote DHCP snooping database file name.
[in] | client_handle | Client handle from registration API |
[in] | family | OPEN_AF_INET or OPEN_AF_INET6 |
[out] | fileName | Remote DHCP snooping DB file name |
- | Minimum allowed value of buffer length is iobtainable by calling openapiDhcpSnoopingFileNameMaxLengthGet() |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_FAIL | On failure |
OpEN API Version: 1.18
open_error_t openapiDhcpSnoopingDbFileNameMaxLengthGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | len | ||
) |
Get the remote DHCP snooping database file name max length.
[in] | client_handle | Client handle from registration API |
[out] | len | Maximum length of filename including NULL. |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_FAIL | On failure |
OpEN API Version: 1.18
open_error_t openapiDhcpSnoopingDbIpAddressGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | family, | ||
open_inet_addr_t * | addr | ||
) |
Get the remote DHCP snooping database IPv4 Address.
[in] | client_handle | Client handle from registration API |
[in] | family | OPEN_AF_INET or OPEN_AF_INET6 |
[out] | addr | Remote DHCP snooping DB IP Address |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_FAIL | On failure |
OpEN API Version: 1.18
open_error_t openapiDhcpSnoopingDbWriteDelayGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | family, | ||
uint32_t * | delay | ||
) |
Get the DHCP snooping database write delay.
[in] | client_handle | Client handle from registration API |
[in] | family | OPEN_AF_INET or OPEN_AF_INET6 |
[out] | Write | delay in seconds. |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_FAIL | On failure |
OpEN API Version: 1.18
open_error_t openapiDhcpSnoopingEnabledVlanRangeNextGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | family, | ||
uint32_t * | vlanStart, | ||
uint32_t * | vlanEnd | ||
) |
Given a VLAN ID, return the endpoints of the next range of VLANs enabled for DHCP snooping.
[in] | client_handle | Client handle from registration API |
[in] | family | OPEN_AF_INET or OPEN_AF_INET6 |
[out] | vlanStart | Low end of VLAN range |
[in,out] | vlanEnd | High end of VLAN range |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_NOT_FOUND | No further VLANs beyond vlanEnd |
OPEN_E_FAIL | On failure |
OPEN_E_UNAVAIL | IPv6 requested but support is unavailable |
OpEN API Version: 1.18
open_error_t openapiDhcpSnoopingIntfLoggedGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | family, | ||
uint32_t | ifNum, | ||
OPEN_BOOL_t * | logged | ||
) |
Determines whether DHCP snooping logs invalid packets on an interface.
[in] | client_handle | Client handle from registration API |
[in] | family | OPEN_AF_INET or OPEN_AF_INET6 |
[in] | ifNum | Internal interface number |
[out] | logged | OPEN_TRUE if invalid packets logged for interface, else OPEN_FALSE |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_FAIL | On failure |
OPEN_E_UNAVAIL | IPv6 requested but support is unavailable |
OpEN API Version: 1.18
open_error_t openapiDhcpSnoopingIntfTrustedGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | family, | ||
uint32_t | ifNum, | ||
OPEN_BOOL_t * | trusted | ||
) |
Determines whether DHCP snooping considers an interface as trusted.
[in] | client_handle | Client handle from registration API |
[in] | family | OPEN_AF_INET or OPEN_AF_INET6 |
[in] | ifNum | Internal interface number |
[out] | trusted | OPEN_TRUE if trusted, else OPEN_FALSE |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_FAIL | On failure |
OPEN_E_UNAVAIL | IPv6 requested but support is unavailable |
OpEN API Version: 1.18
open_error_t openapiDhcpSnoopingPortEnabledGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | family, | ||
uint32_t | ifNum, | ||
OPEN_CONTROL_t * | enabled | ||
) |
Determines whether DHCP snooping is enabled on a port.
[in] | client_handle | Client handle from registration API |
[in] | family | OPEN_AF_INET or OPEN_AF_INET6 |
[in] | ifNum | Internal interface number |
[out] | enabled | OPEN_ENABLE if DHCP snooping is enabled on port, else OPEN_DISABLE |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_FAIL | On failure |
OPEN_E_UNAVAIL | IPv6 requested but support is unavailable |
OpEN API Version: 1.18
open_error_t openapiDhcpSnoopingVerifySourceMacGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_AF_t | family, | ||
OPEN_CONTROL_t * | sourceMacVerify | ||
) |
Gets whether DHCP snooping verifies source MAC addresses.
[in] | client_handle | Client handle from registration API |
[in] | family | OPEN_AF_INET or OPEN_AF_INET6 |
[out] | sourceMacVerify | If OPEN_ENABLE, source MAC addresses verified, otherwise OPEN_DISABLE |
OPEN_E_NONE | On success |
OPEN_E_PARAM | Invalid parameter |
OPEN_E_FAIL | On failure |
OPEN_E_UNAVAIL | IPv6 requested but support is unavailable |
OpEN API Version: 1.18