sflow

Sflow allows ACOS to collect information about Ethernet data interfaces and send the data to an external sFlow collector.

sflow Specification

Type Intermediate Resource
Element Name sflow
Element URI /axapi/v3/sflow
Element Attributes sflow_attributes
Schema sflow schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/sflow

sflow_attributes

sflow Attributes

agent

Description: agent is a JSON Block . Please see below for agent

Type: Object

Reference Object: /axapi/v3/sflow/agent

collector

Description: collector is a JSON Block . Please see below for collector

Type: Object

Reference Object: /axapi/v3/sflow/collector

global

Description: global is a JSON Block . Please see below for global

Type: Object

Reference Object: /axapi/v3/sflow/global

polling

Description: polling is a JSON Block . Please see below for polling

Type: Object

Reference Object: /axapi/v3/sflow/polling

sampling

Description: sampling is a JSON Block . Please see below for sampling

Type: Object

Reference Object: /axapi/v3/sflow/sampling

setting

Description: setting is a JSON Block . Please see below for setting

Type: Object

Reference Object: /axapi/v3/sflow/setting

source-address

Description: source-address is a JSON Block . Please see below for source-address

Type: Object

Reference Object: /axapi/v3/sflow/source-address

source-address

Specification
Type object

ip

Description: Source IPv4 address

Type: string

Format: ipv4-address

ipv6

Description: Source IPv6 address

Type: string

Format: ipv6-address

uuid

Description: uuid of the object

Type: string

global

Specification
Type object

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l248_sampling-enable

Type: List

global.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘total-packet-sample-records’: Total packet sample records; ‘total-counter-sample-records’: Total counter sample records; ‘total-sflow-packets-sent’: Total sflow packets sent;

Type: string

Supported Values: all, total-packet-sample-records, total-counter-sample-records, total-sflow-packets-sent

agent

Specification
Type object

address

Description: address is a JSON Block . Please see below for l248_address

Type: Object

Reference Object: /axapi/v3/sflow/agent/address

agent.address

Specification
Type object

ip

Description: Configure sFlow agent IP address

Type: string

Format: ipv4-address

Mutual Exclusion: ip and ipv6 are mutually exclusive

ipv6

Description: Configure sFlow agent IPv6 address

Type: string

Format: ipv6-address

Mutual Exclusion: ipv6 and ip are mutually exclusive

uuid

Description: uuid of the object

Type: string

sampling

Specification
Type object

eth-list

Description: eth-list is a JSON List . Please see below for l248_eth-list

Type: List

uuid

Description: uuid of the object

Type: string

ve-list

Description: ve-list is a JSON List . Please see below for l248_ve-list

Type: List

sampling.eth-list

Specification
Type list
Block object keys

eth-end

Description: Ethernet interface to sample

Type: number

Format: interface

eth-start

Description: Ethernet interface to sample

Type: number

Format: interface

sampling.ve-list

Specification
Type list
Block object keys

ve-end

Description: VE interface to sample

Type: number

Reference Object: /axapi/v3/interface/ve

ve-start

Description: VE interface to sample

Type: number

Reference Object: /axapi/v3/interface/ve

setting

Specification
Type object

counter-polling-interval

Description: sFlow counter polling interval, default is 20

Type: number

Range: 1-200

Default: 20

max-header

Description: Configure maximum number of bytes that should be copied from a sampled packet (default: 128) (The maximum number of bytes (Default: 128))

Type: number

Range: 14-512

Default: 128

packet-sampling-rate

Description: sFlow packet sampling rate, default is 1000

Type: number

Range: 10-1000000

Default: 1000

source-ip-use-mgmt

Description: Use management interface’s IP address for source IP of sFlow packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

polling

Specification
Type object

cpu-usage

Description: Polling CPU usage

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

eth-list

Description: eth-list is a JSON List . Please see below for l248_eth-list

Type: List

http-counter

Description: Polling HTTP counters

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

ve-list

Description: ve-list is a JSON List . Please see below for l248_ve-list

Type: List

polling.eth-list

Specification
Type list
Block object keys

eth-end

Description: Ethernet interface to sample

Type: number

Format: interface

eth-start

Description: Ethernet interface to sample

Type: number

Format: interface

polling.ve-list

Specification
Type list
Block object keys

ve-end

Description: VE interface to sample

Type: number

Reference Object: /axapi/v3/interface/ve

ve-start

Description: VE interface to sample

Type: number

Reference Object: /axapi/v3/interface/ve

collector

Specification
Type object

ip-list

Description: ip-list is a JSON List . Please see below for l248_ip-list

Type: List

Reference Object: /axapi/v3/sflow/collector/ip/{addr}+{port}

ipv6-list

Description: ipv6-list is a JSON List . Please see below for l248_ipv6-list

Type: List

Reference Object: /axapi/v3/sflow/collector/ipv6/{addr}+{port}

collector.ip-list

Specification
Type list
Block object keys

addr

Description: Configure sFlow collector IP address

Type: string

Format: ipv4-address

port

Description: Port number (default is 6343)

Type: number

Range: 1-65535

Default: 6343

uuid

Description: uuid of the object

Type: string

collector.ipv6-list

Specification
Type list
Block object keys

addr

Description: Configure sFlow collector IPv6 address

Type: string

Format: ipv6-address

port

Description: Port number (default is 6343)

Type: number

Range: 1-65535

Default: 6343

uuid

Description: uuid of the object

Type: string