sflow¶
Configure sFlow
sflow Specification¶
Parameter
Value
Type
Intermediate Resource
Element Name
sflow
Element URI
/axapi/v3/sflow
Element Attributes
sflow_attributes
Partition Visibility
shared
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
setting¶
Specification
Value
Type
object
counter-polling-interval
Description sFlow counter polling interval, default is 20
Type: number
Range: 1-200
Default: 10
local-collection
Description ‘enable’: Enable local sflow collection (Default); ‘disable’: Disable local sflow collection;
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
Maximum Length: 64 characters
Maximum Length: 1 characters
collector¶
Specification
Value
Type
object
ip-list
Type: List
Reference Object: /axapi/v3/sflow/collector/ip/{addr}+{port}
ipv6-list
Type: List
Reference Object: /axapi/v3/sflow/collector/ipv6/{addr}+{port}
collector_ip-list¶
Specification
Value
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
Maximum Length: 64 characters
Maximum Length: 1 characters
collector_ipv6-list¶
Specification
Value
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
Maximum Length: 64 characters
Maximum Length: 1 characters
agent¶
Specification
Value
Type
object
address
Description: address is a JSON Block. Please see below for agent_address
Type: Object
Reference Object: /axapi/v3/sflow/agent/address
agent_address¶
Specification
Value
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
Maximum Length: 64 characters
Maximum Length: 1 characters
source-address¶
Specification
Value
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
Maximum Length: 64 characters
Maximum Length: 1 characters
polling¶
Specification
Value
Type
object
cpu-usage
Description Polling CPU usage
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-list
Type: List
polling_eth-list¶
Specification
Value
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
Value
Type
list
Block object keys
ve-end
ve-start
sampling¶
Specification
Value
Type
object
eth-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-list
Type: List
sampling_eth-list¶
Specification
Value
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
Value
Type
list
Block object keys
ve-end
ve-start
global¶
Specification
Value
Type
object
sampling-enable
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
global_sampling-enable¶
Specification
Value
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; ‘total-sflow-local-packets-sent’: Total sflow packets sent desc {}; ‘total-sflow-packets-sent-mgmt’: Total sflow packets sent via Mgmt Interface; ‘total-sflow-packets-drop-mgmt’: sflow packets dropped because of rate limit via Mgmt Interface;
Type: string
Supported Values: all, total-packet-sample-records, total-counter-sample-records, total-sflow-packets-sent