Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
SFlow Configuration And Status [OPENAPI_SFLOW]

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...
 

Detailed Description

Function Documentation

open_error_t openapiSflowCpIntervalGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  instance,
uint32_t *  interval 
)

Get the counter polling interval.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancepoller instance Id
[out]intervalinterval
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowCpIntervalRangeGet ( openapiClientHandle_t client_handle,
uint32_t *  minInterval,
uint32_t *  maxInterval 
)

Get the supported range of sFlow counter polling interval values.

Parameters
[in]client_handleclient handle from registration API
[out]minIntervalpolling interval minimum value
[out]maxIntervalpolling interval maximum value
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowCpIntervalSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  instance,
uint32_t  interval 
)

Set the counter polling interval.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancepoller instance Id
[in]intervalinterval
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_EXISTSAlready configured with this interval
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancepoller instance Id
[out]rcvrIndexpoller receiver index
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed
OPEN_E_ERRORInternal error

OpEN API Version: 1.14

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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancepoller instance Id
[in]rcvrIndexpoller receiver index
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_EXISTSAlready associated with another receiver
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowFsMaximumHeaderSizeGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  instance,
uint32_t *  size 
)

Get the sFlow sampler maximum header size.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancesampler instance Id
[out]sizemaximum header size
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

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.

Parameters
[in]client_handleclient handle from registration API
[out]minHeaderSizeheader size minimum value
[out]maxHeaderSizeheader size maximum value
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowFsMaximumHeaderSizeSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  instance,
uint32_t  size 
)

Set the sFlow sampler maximum header size.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancesampler instance Id
[in]sizemaximum header size
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancesampler instance Id
[in]typesampling type
[out]ratesampling rate
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

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.

Parameters
[in]client_handleclient handle from registration API
[out]minRateminimum sampling rate
[out]maxRatemaximum sampling rate
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

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.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancesampler instance Id
[in]typesampling type
[in]ratesampling rate
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

open_error_t openapiSflowFsRcvrIndexGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  instance,
uint32_t *  rcvrIndex 
)

Get the sFlow sampler receiver index.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancesampler instance Id
[out]rcvrIndexsampler receiver index
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowFsRcvrIndexSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  instance,
uint32_t  rcvrIndex 
)

Set the sFlow sampler receiver index.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancesampler instance Id
[in]rcvrIndexsampler receiver index
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
OPEN_E_EXISTSReceiver index is already configured
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

open_error_t openapiSflowFsRemoteAgentIndexGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  instance,
uint32_t *  index 
)

Get the sFlow sampler remote agent index.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancesampler instance ID
[out]indexremote agent index
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed
OPEN_E_UNAVAILsFlow remote agent feature is not supported on the platform

OpEN API Version: 1.14

open_error_t openapiSflowFsRemoteAgentIndexSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  instance,
uint32_t  index 
)

Set the sFlow sampler remote agent index.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]instancesampler instance ID
[in]indexremote agent index
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
OPEN_E_UNAVAILsFlow remote agent feature is not supported on the platform
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

uint32_t openapiSflowFsRemoteAgentMaxIndexGet ( openapiClientHandle_t client_handle)

Get the sFlow sampler remote agent index maximum value supported.

Parameters
[in]client_handleclient handle from registration API
Returns
maximum remote agent index value

OpEN API Version: 1.14

uint32_t openapiSflowFsRemoteAgentMaxMonitorSessionIdGet ( openapiClientHandle_t client_handle)

Get the sFlow sampler remote agent session ID maximum value supported.

Parameters
[in]client_handleclient handle from registration API
Returns
maximum remote agent session ID value

OpEN API Version: 1.14

open_error_t openapiSflowInstanceRangeGet ( openapiClientHandle_t client_handle,
uint32_t *  minInstance,
uint32_t *  maxInstance 
)

Get the supported range of sFlow instance ID values.

Parameters
[in]client_handleclient handle from registration API
[out]minInstanceinstance ID minimum value
[out]maxInstanceinstance ID maximum value
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowRcvrAddressGet ( openapiClientHandle_t client_handle,
uint32_t  index,
open_inet_addr_t ipAddr 
)

Get the sFlow receiver IP address.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow receiver index
[out]ipAddrsFlow receiver IP address
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowRcvrAddressSet ( openapiClientHandle_t client_handle,
uint32_t  index,
open_inet_addr_t ipAddr 
)

Set the sFlow receiver IP address.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow receiver index
[in]ipAddrsFlow receiver IP address
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

uint32_t openapiSflowRcvrCountGet ( openapiClientHandle_t client_handle)

Get the number of sFlow receivers the switch supports.

Parameters
[in]client_handleclient handle from registration API
Returns
number of sFlow receivers
Note
The value returned by this function is used to determine the valid range of receiver indices. The valid indices are in the range from 1 to the value returned by this function.

OpEN API Version: 1.14

open_error_t openapiSflowRcvrMaxDatagramSizeGet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t *  size 
)

Get the sFlow receiver maximum datagram size.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow receiver index
[out]sizesFlow receiver max datagram size
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

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.

Parameters
[in]client_handleclient handle from registration API
[out]minSizesmallest sFlow receiver max datagram size parameter supported
[out]maxSizelargest sFlow receiver max datagram size parameter supported
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowRcvrMaxDatagramSizeSet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t  size 
)

Set the sFlow receiver maximum datagram size.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow receiver index
[in]sizesFlow receiver max datagram size, accepted values are returned by openapiSflowRcvrMaxDatagramSizeRangeGet()
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

open_error_t openapiSflowRcvrOwnerGet ( openapiClientHandle_t client_handle,
uint32_t  index,
open_buffdesc owner 
)

Get the sFlow receiver owner string.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow receiver index
[out]ownersFlow receiver owner string, buffer must have space to store a string the length of the value returned by openapiSflowOwnerStringLenGet()
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

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.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow receiver index
[in]ownersFlow receiver owner, call openapiSflowOwnerStringLenGet() to get maximum owner string length
[in]timeoutsFlow receiver timeout value in seconds, see note for information about special values
Note
Calling this API will change the running configuration of the switch.
Setting timeout to OPEN_SFLOW_RCVR_NO_TIMEOUT disables expiration of the receiver entry. Set to a value greater than 0 to configure the number of seconds until the entry times out. Set to 0 to delete the receiver entry immediately.
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
OPEN_E_EXISTSReceiver owner is already configured

OpEN API Version: 1.14

uint32_t openapiSflowRcvrOwnerStringLenGet ( openapiClientHandle_t client_handle)

Get the maximum length string for the sFlow receiver owner.

Parameters
[in]client_handleclient handle from registration API
Returns
The maximum length the owner string including the terminating NULL.

OpEN API Version: 1.14

open_error_t openapiSflowRcvrPortGet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t *  port 
)

Get the sFlow receiver port.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow receiver index
[out]portsFlow receiver port
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowRcvrPortSet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t  port 
)

Set the sFlow receiver port.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow receiver index
[in]portsFlow receiver port, accepted port number values are 1 to 65535
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

open_error_t openapiSflowRcvrTimeRemainingGet ( openapiClientHandle_t client_handle,
uint32_t  index,
int32_t *  timeRemaining 
)

Get the time remaining before the sFlow receiver entry expires.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow receiver index
[out]timeRemainingremaining time before receiver expires in seconds
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed
Note
A returned value of OPEN_SFLOW_RCVR_NO_TIMEOUT indicates expiration of the receiver entry is disabled.

OpEN API Version: 1.14

open_error_t openapiSflowRemoteAgentAddressGet ( openapiClientHandle_t client_handle,
uint32_t  index,
open_inet_addr_t ipAddr 
)

Get the sFlow remote agent IP address.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow remote agent index
[out]ipAddrsFlow remote agent IP address
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowRemoteAgentAddressSet ( openapiClientHandle_t client_handle,
uint32_t  index,
open_inet_addr_t ipAddr 
)

Set the sFlow remote agent IP address.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow remote agent index
[in]ipAddrsFlow remote agent IP address
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

open_error_t openapiSflowRemoteAgentMonitorSessionDestIfaceGet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t *  ifNum 
)

Get the sFlow remote agent monitor session destination interface.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow remote agent index
[out]ifNummonitor session destination interface
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_NOT_FOUNDMonitor session does not exist
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowRemoteAgentMonitorSessionDestIfaceSet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t  ifNum 
)

Set the sFlow remote agent monitor session destination interface.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow remote agent index
[in]ifNummonitor session destination interface
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_NOT_FOUNDMonitor session does not exist
OPEN_E_PARAMError in parameter passed
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

open_error_t openapiSflowRemoteAgentMonitorSessionGet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t *  monitorSessionId 
)

Get the sFlow sampler remote agent index.

Parameters
[in]client_handleclient handle from registration API
[in]indexremote agent index
[out]monitorSessionIdmonitor session ID
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed
OPEN_E_UNAVAILsFlow remote agent feature is not supported on the platform

OpEN API Version: 1.14

open_error_t openapiSflowRemoteAgentMonitorSessionSet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t  monitorSessionId 
)

Set the sFlow sampler remote agent index.

Parameters
[in]client_handleclient handle from registration API
[in]indexremote agent index
[in]monitorSessionIdmonitor session ID
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
OPEN_E_UNAVAILsFlow remote agent feature is not supported on the platform

OpEN API Version: 1.14

open_error_t openapiSflowRemoteAgentSourceInterfaceGet ( openapiClientHandle_t client_handle,
uint32_t *  ifNum 
)

Get the sFlow remote agent client source interface number.

Parameters
[in]client_handleclient handle from registration API
[out]ifNuminterface number
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed
OPEN_E_UNAVAILFeature not supported
OPEN_E_INTERNALFailed to get source interface number

OpEN API Version: 1.15

open_error_t openapiSflowRemoteAgentSourceInterfaceSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum 
)

Set the sFlow remote agent client source interface number.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
Return values
OPEN_E_NONESet successful
OPEN_E_PARAMError in parameter passed
OPEN_E_UNAVAILFeature not supported
OPEN_E_INTERNALFailed to set source interface number

OpEN API Version: 1.15

open_error_t openapiSflowRemoteAgentSourceIpv4AddrGet ( openapiClientHandle_t client_handle,
uint32_t *  ipAddr 
)

Get the source IPv4 address of the sFlow Remote agents client.

Parameters
[in]client_handleclient handle from registration API
[out]ipAddrIPv4 address
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.15

open_error_t openapiSflowRemoteAgentSourceIpv6AddrGet ( openapiClientHandle_t client_handle,
open_in6_addr_t ipv6Addr 
)

Get the source IPv6 address of the sFlow Remote agents client.

Parameters
[in]client_handleclient handle from registration API
[out]ipv6AddrIPv6 address
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.15

open_error_t openapiSflowRemoteAgentUdpDestPortGet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t *  port 
)

Get the sFlow remote agent destination UDP port.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow remote agent index
[out]portsFlow remote agent destination UDP port
Return values
OPEN_E_NONEGet successful
OPEN_E_FAILGet failed
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowRemoteAgentUdpDestPortSet ( openapiClientHandle_t client_handle,
uint32_t  index,
uint32_t  port 
)

Set the sFlow remote agent destination UDP port.

Parameters
[in]client_handleclient handle from registration API
[in]indexsFlow remote agent index
[in]portsFlow remote agent destination UDP port
Return values
OPEN_E_NONESet successful
OPEN_E_FAILSet failed
OPEN_E_PARAMError in parameter passed
Note
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.14

open_error_t openapiSflowSamplerIpAclGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  aclNum 
)

Get the flow-based sFlow sampler attached IP ACL.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]aclNumIP ACL number
Return values
OPEN_E_UNAVAILAPI/feature not supported.
Note
This API is deprecated. To enable flow based sFlow sampling configure IP ACL rules(permit/deny) sflow-remote-agent action.

Deprecated OpEN API Version: 1.14 OpEN API Version: 1.15

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.

Parameters
[in]client_handleclient handle from registration API
[in]indexsampler receiver index
[in]ifNuminterface number
[in]aclNumIP ACL number
[in]actionOPEN_ENABLE to add ACL, OPEN_DISABLE to remove ACL
Return values
OPEN_E_UNAVAILAPI/feature not supported.
Note
This API is deprecated. To enable flow based sFlow sampling configure IP ACL rules(permit/deny) sflow-remote-agent action.

Deprecated OpEN API Version: 1.14 OpEN API Version: 1.15

open_error_t openapiSflowSamplerMacAclGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t *  aclNum 
)

Get the flow-based sFlow sampler attached MAC ACL.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]aclNumMAC ACL number
Return values
OPEN_E_UNAVAILAPI/feature not supported.
Note
This API is deprecated. To enable flow based sFlow sampling configure MAC ACL rules(permit/deny) sflow-remote-agent action.

Deprecated OpEN API Version: 1.14 OpEN API Version: 1.15

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.

Parameters
[in]client_handleclient handle from registration API
[in]indexsampler receiver index
[in]ifNuminterface number
[in]aclNumMAC ACL number
[in]actionOPEN_ENABLE to add ACL, OPEN_DISABLE to remove ACL
Return values
OPEN_E_UNAVAILAPI/feature not supported.
Note
This API is deprecated. To enable flow based sFlow sampling configure MAC ACL rules(permit/deny) sflow-remote-agent action.

Deprecated OpEN API Version: 1.14 OpEN API Version: 1.15

open_error_t openapiSflowSourceInterfaceGet ( openapiClientHandle_t client_handle,
uint32_t *  ifNum 
)

Get the source interface number of the sFlow client.

Parameters
[in]client_handleclient handle from registration API
[out]ifNuminterface number
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowSourceInterfaceSet ( openapiClientHandle_t client_handle,
uint32_t  ifNum 
)

Set the source interface number of the sFlow client.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
Return values
OPEN_E_NONESet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowSourceIpv4AddrGet ( openapiClientHandle_t client_handle,
uint32_t *  ipAddr 
)

Get the source IPv4 address of the sFlow client.

Parameters
[in]client_handleclient handle from registration API
[out]ipAddrIPv4 address
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14

open_error_t openapiSflowSourceIpv6AddrGet ( openapiClientHandle_t client_handle,
open_in6_addr_t ipv6Addr 
)

Get the source IPv6 address of the sFlow client.

Parameters
[in]client_handleclient handle from registration API
[out]ipv6AddrIPv6 address
Return values
OPEN_E_NONEGet successful
OPEN_E_PARAMError in parameter passed

OpEN API Version: 1.14