Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
openapi_sflow.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_SFLOW_RCVR_NO_TIMEOUT   (-1)
 

Enumerations

enum  OPEN_SFLOW_SAMPLING_TYPE_t { OPEN_SFLOW_SAMPLING_TYPE_INGRESS = 0, OPEN_SFLOW_SAMPLING_TYPE_FLOW_BASED = 1, OPEN_SFLOW_SAMPLING_TYPE_EGRESS = 2 }
 

Functions

open_error_t openapiSflowCpIntervalGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t *interval)
 Get the counter polling interval. More...
 
open_error_t openapiSflowCpIntervalRangeGet (openapiClientHandle_t *client_handle, uint32_t *minInterval, uint32_t *maxInterval)
 Get the supported range of sFlow counter polling interval values. More...
 
open_error_t openapiSflowCpIntervalSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t interval)
 Set the counter polling interval. More...
 
open_error_t openapiSflowCpRcvrIndexGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t *rcvrIndex)
 Get the receiver index associated with a counter poller. More...
 
open_error_t openapiSflowCpRcvrIndexSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t rcvrIndex)
 Set the receiver index associated with a counter poller. More...
 
open_error_t openapiSflowFsMaximumHeaderSizeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t *size)
 Get the sFlow sampler maximum header size. More...
 
open_error_t openapiSflowFsMaximumHeaderSizeRangeGet (openapiClientHandle_t *client_handle, uint32_t *minHeaderSize, uint32_t *maxHeaderSize)
 Get the supported range of sFlow maximum header size ID values. More...
 
open_error_t openapiSflowFsMaximumHeaderSizeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t size)
 Set the sFlow sampler maximum header size. More...
 
open_error_t openapiSflowFsPacketSamplingRateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, OPEN_SFLOW_SAMPLING_TYPE_t type, uint32_t *rate)
 Get the sFlow sampler packet sampling rate. More...
 
open_error_t openapiSflowFsPacketSamplingRateRangeGet (openapiClientHandle_t *client_handle, uint32_t *minRate, uint32_t *maxRate)
 Get the supported range of sFlow flow sampler packet sampling rate parameter values. More...
 
open_error_t openapiSflowFsPacketSamplingRateSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, OPEN_SFLOW_SAMPLING_TYPE_t type, uint32_t rate)
 Set the sFlow sampler packet sampling rate. More...
 
open_error_t openapiSflowFsRcvrIndexGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t *rcvrIndex)
 Get the sFlow sampler receiver index. More...
 
open_error_t openapiSflowFsRcvrIndexSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t rcvrIndex)
 Set the sFlow sampler receiver index. More...
 
open_error_t openapiSflowFsRemoteAgentIndexGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t *index)
 Get the sFlow sampler remote agent index. More...
 
open_error_t openapiSflowFsRemoteAgentIndexSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t index)
 Set the sFlow sampler remote agent index. More...
 
uint32_t openapiSflowFsRemoteAgentMaxIndexGet (openapiClientHandle_t *client_handle)
 Get the sFlow sampler remote agent index maximum value supported. More...
 
uint32_t openapiSflowFsRemoteAgentMaxMonitorSessionIdGet (openapiClientHandle_t *client_handle)
 Get the sFlow sampler remote agent session ID maximum value supported. More...
 
open_error_t openapiSflowInstanceRangeGet (openapiClientHandle_t *client_handle, uint32_t *minInstance, uint32_t *maxInstance)
 Get the supported range of sFlow instance ID values. More...
 
open_error_t openapiSflowRcvrAddressGet (openapiClientHandle_t *client_handle, uint32_t index, open_inet_addr_t *ipAddr)
 Get the sFlow receiver IP address. More...
 
open_error_t openapiSflowRcvrAddressSet (openapiClientHandle_t *client_handle, uint32_t index, open_inet_addr_t *ipAddr)
 Set the sFlow receiver IP address. More...
 
uint32_t openapiSflowRcvrCountGet (openapiClientHandle_t *client_handle)
 Get the number of sFlow receivers the switch supports. More...
 
open_error_t openapiSflowRcvrMaxDatagramSizeGet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t *size)
 Get the sFlow receiver maximum datagram size. More...
 
open_error_t openapiSflowRcvrMaxDatagramSizeRangeGet (openapiClientHandle_t *client_handle, uint32_t *minSize, uint32_t *maxSize)
 Get the sFlow receiver maximum datagram size parameter minimum and maximum values supported by the switch. More...
 
open_error_t openapiSflowRcvrMaxDatagramSizeSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t size)
 Set the sFlow receiver maximum datagram size. More...
 
open_error_t openapiSflowRcvrOwnerGet (openapiClientHandle_t *client_handle, uint32_t index, open_buffdesc *owner)
 Get the sFlow receiver owner string. More...
 
open_error_t openapiSflowRcvrOwnerSet (openapiClientHandle_t *client_handle, uint32_t index, open_buffdesc *owner, int32_t timeout)
 Set the sFlow receiver owner string and timeout. More...
 
uint32_t openapiSflowRcvrOwnerStringLenGet (openapiClientHandle_t *client_handle)
 Get the maximum length string for the sFlow receiver owner. More...
 
open_error_t openapiSflowRcvrPortGet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t *port)
 Get the sFlow receiver port. More...
 
open_error_t openapiSflowRcvrPortSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t port)
 Set the sFlow receiver port. More...
 
open_error_t openapiSflowRcvrTimeRemainingGet (openapiClientHandle_t *client_handle, uint32_t index, int32_t *timeRemaining)
 Get the time remaining before the sFlow receiver entry expires. More...
 
open_error_t openapiSflowRemoteAgentAddressGet (openapiClientHandle_t *client_handle, uint32_t index, open_inet_addr_t *ipAddr)
 Get the sFlow remote agent IP address. More...
 
open_error_t openapiSflowRemoteAgentAddressSet (openapiClientHandle_t *client_handle, uint32_t index, open_inet_addr_t *ipAddr)
 Set the sFlow remote agent IP address. More...
 
open_error_t openapiSflowRemoteAgentMonitorSessionDestIfaceGet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t *ifNum)
 Get the sFlow remote agent monitor session destination interface. More...
 
open_error_t openapiSflowRemoteAgentMonitorSessionDestIfaceSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t ifNum)
 Set the sFlow remote agent monitor session destination interface. More...
 
open_error_t openapiSflowRemoteAgentMonitorSessionGet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t *monitorSessionId)
 Get the sFlow sampler remote agent index. More...
 
open_error_t openapiSflowRemoteAgentMonitorSessionSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t monitorSessionId)
 Set the sFlow sampler remote agent index. More...
 
open_error_t openapiSflowRemoteAgentSourceInterfaceGet (openapiClientHandle_t *client_handle, uint32_t *ifNum)
 Get the sFlow remote agent client source interface number. More...
 
open_error_t openapiSflowRemoteAgentSourceInterfaceSet (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Set the sFlow remote agent client source interface number. More...
 
open_error_t openapiSflowRemoteAgentSourceIpv4AddrGet (openapiClientHandle_t *client_handle, uint32_t *ipAddr)
 Get the source IPv4 address of the sFlow Remote agents client. More...
 
open_error_t openapiSflowRemoteAgentSourceIpv6AddrGet (openapiClientHandle_t *client_handle, open_in6_addr_t *ipv6Addr)
 Get the source IPv6 address of the sFlow Remote agents client. More...
 
open_error_t openapiSflowRemoteAgentUdpDestPortGet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t *port)
 Get the sFlow remote agent destination UDP port. More...
 
open_error_t openapiSflowRemoteAgentUdpDestPortSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t port)
 Set the sFlow remote agent destination UDP port. More...
 
open_error_t openapiSflowSamplerIpAclGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *aclNum)
 Get the flow-based sFlow sampler attached IP ACL. More...
 
open_error_t openapiSflowSamplerIpAclSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t ifNum, uint32_t aclNum, OPEN_CONTROL_t action)
 Set the flow-based sFlow sampler IP ACL action. More...
 
open_error_t openapiSflowSamplerMacAclGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *aclNum)
 Get the flow-based sFlow sampler attached MAC ACL. More...
 
open_error_t openapiSflowSamplerMacAclSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t ifNum, uint32_t aclNum, OPEN_CONTROL_t action)
 Set the flow-based sFlow sampler MAC ACL action. More...
 
open_error_t openapiSflowSourceInterfaceGet (openapiClientHandle_t *client_handle, uint32_t *ifNum)
 Get the source interface number of the sFlow client. More...
 
open_error_t openapiSflowSourceInterfaceSet (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Set the source interface number of the sFlow client. More...
 
open_error_t openapiSflowSourceIpv4AddrGet (openapiClientHandle_t *client_handle, uint32_t *ipAddr)
 Get the source IPv4 address of the sFlow client. More...
 
open_error_t openapiSflowSourceIpv6AddrGet (openapiClientHandle_t *client_handle, open_in6_addr_t *ipv6Addr)
 Get the source IPv6 address of the sFlow client. More...