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.

open_error_t	openapiSflowCpIntervalRangeGet (openapiClientHandle_t client_handle, uint32_t minInterval, uint32_t *maxInterval)
	Get the supported range of sFlow counter polling interval values.

open_error_t	openapiSflowCpIntervalSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t interval)
	Set the counter polling interval.

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.

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.

open_error_t	openapiSflowFsMaximumHeaderSizeGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t instance, uint32_t size)
	Get the sFlow sampler maximum header size.

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.

open_error_t	openapiSflowFsMaximumHeaderSizeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t size)
	Set the sFlow sampler maximum header size.

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.

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.

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.

open_error_t	openapiSflowFsRcvrIndexGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t instance, uint32_t rcvrIndex)
	Get the sFlow sampler receiver index.

open_error_t	openapiSflowFsRcvrIndexSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t rcvrIndex)
	Set the sFlow sampler receiver index.

open_error_t	openapiSflowFsRemoteAgentIndexGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t instance, uint32_t index)
	Get the sFlow sampler remote agent index.

open_error_t	openapiSflowFsRemoteAgentIndexSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t instance, uint32_t index)
	Set the sFlow sampler remote agent index.

uint32_t	openapiSflowFsRemoteAgentMaxIndexGet (openapiClientHandle_t *client_handle)
	Get the sFlow sampler remote agent index maximum value supported.

uint32_t	openapiSflowFsRemoteAgentMaxMonitorSessionIdGet (openapiClientHandle_t *client_handle)
	Get the sFlow sampler remote agent session ID maximum value supported.

open_error_t	openapiSflowInstanceRangeGet (openapiClientHandle_t client_handle, uint32_t minInstance, uint32_t *maxInstance)
	Get the supported range of sFlow instance ID values.

open_error_t	openapiSflowRcvrAddressGet (openapiClientHandle_t client_handle, uint32_t index, open_inet_addr_t ipAddr)
	Get the sFlow receiver IP address.

open_error_t	openapiSflowRcvrAddressSet (openapiClientHandle_t client_handle, uint32_t index, open_inet_addr_t ipAddr)
	Set the sFlow receiver IP address.

uint32_t	openapiSflowRcvrCountGet (openapiClientHandle_t *client_handle)
	Get the number of sFlow receivers the switch supports.

open_error_t	openapiSflowRcvrMaxDatagramSizeGet (openapiClientHandle_t client_handle, uint32_t index, uint32_t size)
	Get the sFlow receiver maximum datagram size.

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.

open_error_t	openapiSflowRcvrMaxDatagramSizeSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t size)
	Set the sFlow receiver maximum datagram size.

open_error_t	openapiSflowRcvrOwnerGet (openapiClientHandle_t client_handle, uint32_t index, open_buffdesc owner)
	Get the sFlow receiver owner string.

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.

uint32_t	openapiSflowRcvrOwnerStringLenGet (openapiClientHandle_t *client_handle)
	Get the maximum length string for the sFlow receiver owner.

open_error_t	openapiSflowRcvrPortGet (openapiClientHandle_t client_handle, uint32_t index, uint32_t port)
	Get the sFlow receiver port.

open_error_t	openapiSflowRcvrPortSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t port)
	Set the sFlow receiver port.

open_error_t	openapiSflowRcvrTimeRemainingGet (openapiClientHandle_t client_handle, uint32_t index, int32_t timeRemaining)
	Get the time remaining before the sFlow receiver entry expires.

open_error_t	openapiSflowRemoteAgentAddressGet (openapiClientHandle_t client_handle, uint32_t index, open_inet_addr_t ipAddr)
	Get the sFlow remote agent IP address.

open_error_t	openapiSflowRemoteAgentAddressSet (openapiClientHandle_t client_handle, uint32_t index, open_inet_addr_t ipAddr)
	Set the sFlow remote agent IP address.

open_error_t	openapiSflowRemoteAgentMonitorSessionDestIfaceGet (openapiClientHandle_t client_handle, uint32_t index, uint32_t ifNum)
	Get the sFlow remote agent monitor session destination interface.

open_error_t	openapiSflowRemoteAgentMonitorSessionDestIfaceSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t ifNum)
	Set the sFlow remote agent monitor session destination interface.

open_error_t	openapiSflowRemoteAgentMonitorSessionGet (openapiClientHandle_t client_handle, uint32_t index, uint32_t monitorSessionId)
	Get the sFlow sampler remote agent index.

open_error_t	openapiSflowRemoteAgentMonitorSessionSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t monitorSessionId)
	Set the sFlow sampler remote agent index.

open_error_t	openapiSflowRemoteAgentSourceInterfaceGet (openapiClientHandle_t client_handle, uint32_t ifNum)
	Get the sFlow remote agent client source interface number.

open_error_t	openapiSflowRemoteAgentSourceInterfaceSet (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Set the sFlow remote agent client source interface number.

open_error_t	openapiSflowRemoteAgentSourceIpv4AddrGet (openapiClientHandle_t client_handle, uint32_t ipAddr)
	Get the source IPv4 address of the sFlow Remote agents client.

open_error_t	openapiSflowRemoteAgentSourceIpv6AddrGet (openapiClientHandle_t client_handle, open_in6_addr_t ipv6Addr)
	Get the source IPv6 address of the sFlow Remote agents client.

open_error_t	openapiSflowRemoteAgentUdpDestPortGet (openapiClientHandle_t client_handle, uint32_t index, uint32_t port)
	Get the sFlow remote agent destination UDP port.

open_error_t	openapiSflowRemoteAgentUdpDestPortSet (openapiClientHandle_t *client_handle, uint32_t index, uint32_t port)
	Set the sFlow remote agent destination UDP port.

open_error_t	openapiSflowSamplerIpAclGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t aclNum)
	Get the flow-based sFlow sampler attached IP ACL.

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.

open_error_t	openapiSflowSamplerMacAclGet (openapiClientHandle_t client_handle, uint32_t ifNum, uint32_t aclNum)
	Get the flow-based sFlow sampler attached MAC ACL.

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.

open_error_t	openapiSflowSourceInterfaceGet (openapiClientHandle_t client_handle, uint32_t ifNum)
	Get the source interface number of the sFlow client.

open_error_t	openapiSflowSourceInterfaceSet (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Set the source interface number of the sFlow client.

open_error_t	openapiSflowSourceIpv4AddrGet (openapiClientHandle_t client_handle, uint32_t ipAddr)
	Get the source IPv4 address of the sFlow client.

open_error_t	openapiSflowSourceIpv6AddrGet (openapiClientHandle_t client_handle, open_in6_addr_t ipv6Addr)
	Get the source IPv6 address of the sFlow client.

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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	poller instance Id
[out]	interval	interval

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	minInterval	polling interval minimum value
[out]	maxInterval	polling interval maximum value

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	poller instance Id
[in]	interval	interval

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_EXISTS	Already configured with this interval
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	poller instance Id
[out]	rcvrIndex	poller receiver index

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error in parameter passed
OPEN_E_ERROR	Internal 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	poller instance Id
[in]	rcvrIndex	poller receiver index

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_EXISTS	Already associated with another receiver
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	sampler instance Id
[out]	size	maximum header size

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	minHeaderSize	header size minimum value
[out]	maxHeaderSize	header size maximum value

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	sampler instance Id
[in]	size	maximum header size

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	sampler instance Id
[in]	type	sampling type
[out]	rate	sampling rate

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	minRate	minimum sampling rate
[out]	maxRate	maximum sampling rate

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	sampler instance Id
[in]	type	sampling type
[in]	rate	sampling rate

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	sampler instance Id
[out]	rcvrIndex	sampler receiver index

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	sampler instance Id
[in]	rcvrIndex	sampler receiver index

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error in parameter passed
OPEN_E_EXISTS	Receiver 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	sampler instance ID
[out]	index	remote agent index

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error in parameter passed
OPEN_E_UNAVAIL	sFlow 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_handle	client handle from registration API
[in]	ifNum	interface number
[in]	instance	sampler instance ID
[in]	index	remote agent index

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error in parameter passed
OPEN_E_UNAVAIL	sFlow 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_handle client 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_handle client 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_handle	client handle from registration API
[out]	minInstance	instance ID minimum value
[out]	maxInstance	instance ID maximum value

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow receiver index
[out]	ipAddr	sFlow receiver IP address

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow receiver index
[in]	ipAddr	sFlow receiver IP address

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error 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_handle client 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_handle	client handle from registration API
[in]	index	sFlow receiver index
[out]	size	sFlow receiver max datagram size

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	minSize	smallest sFlow receiver max datagram size parameter supported
[out]	maxSize	largest sFlow receiver max datagram size parameter supported

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow receiver index
[in]	size	sFlow receiver max datagram size, accepted values are returned by openapiSflowRcvrMaxDatagramSizeRangeGet()

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow receiver index
[out]	owner	sFlow receiver owner string, buffer must have space to store a string the length of the value returned by openapiSflowOwnerStringLenGet()

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow receiver index
[in]	owner	sFlow receiver owner, call openapiSflowOwnerStringLenGet() to get maximum owner string length
[in]	timeout	sFlow 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_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error in parameter passed
OPEN_E_EXISTS	Receiver 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_handle client 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_handle	client handle from registration API
[in]	index	sFlow receiver index
[out]	port	sFlow receiver port

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow receiver index
[in]	port	sFlow receiver port, accepted port number values are 1 to 65535

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow receiver index
[out]	timeRemaining	remaining time before receiver expires in seconds

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow remote agent index
[out]	ipAddr	sFlow remote agent IP address

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow remote agent index
[in]	ipAddr	sFlow remote agent IP address

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow remote agent index
[out]	ifNum	monitor session destination interface

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_NOT_FOUND	Monitor session does not exist
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow remote agent index
[in]	ifNum	monitor session destination interface

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_NOT_FOUND	Monitor session does not exist
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	remote agent index
[out]	monitorSessionId	monitor session ID

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error in parameter passed
OPEN_E_UNAVAIL	sFlow 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_handle	client handle from registration API
[in]	index	remote agent index
[in]	monitorSessionId	monitor session ID

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error in parameter passed
OPEN_E_UNAVAIL	sFlow 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_handle	client handle from registration API
[out]	ifNum	interface number

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error in parameter passed
OPEN_E_UNAVAIL	Feature not supported
OPEN_E_INTERNAL	Failed 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_handle	client handle from registration API
[in]	ifNum	interface number

Return values

OPEN_E_NONE	Set successful
OPEN_E_PARAM	Error in parameter passed
OPEN_E_UNAVAIL	Feature not supported
OPEN_E_INTERNAL	Failed 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_handle	client handle from registration API
[out]	ipAddr	IPv4 address

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	ipv6Addr	IPv6 address

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow remote agent index
[out]	port	sFlow remote agent destination UDP port

Return values

OPEN_E_NONE	Get successful
OPEN_E_FAIL	Get failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	index	sFlow remote agent index
[in]	port	sFlow remote agent destination UDP port

Return values

OPEN_E_NONE	Set successful
OPEN_E_FAIL	Set failed
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number
[out]	aclNum	IP ACL number

Return values

OPEN_E_UNAVAIL API/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_handle	client handle from registration API
[in]	index	sampler receiver index
[in]	ifNum	interface number
[in]	aclNum	IP ACL number
[in]	action	OPEN_ENABLE to add ACL, OPEN_DISABLE to remove ACL

Return values

OPEN_E_UNAVAIL API/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_handle	client handle from registration API
[in]	ifNum	interface number
[out]	aclNum	MAC ACL number

Return values

OPEN_E_UNAVAIL API/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_handle	client handle from registration API
[in]	index	sampler receiver index
[in]	ifNum	interface number
[in]	aclNum	MAC ACL number
[in]	action	OPEN_ENABLE to add ACL, OPEN_DISABLE to remove ACL

Return values

OPEN_E_UNAVAIL API/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_handle	client handle from registration API
[out]	ifNum	interface number

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	ifNum	interface number

Return values

OPEN_E_NONE	Set successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	ipAddr	IPv4 address

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	ipv6Addr	IPv6 address

Return values

OPEN_E_NONE	Get successful
OPEN_E_PARAM	Error in parameter passed

OpEN API Version: 1.14

Macros

Enumerations

Functions

Detailed Description

Function Documentation