sflow setting¶

Configure sFlow

setting Specification¶

Parameter Value

Type Configuration Resource

Element Name setting

Element URI /axapi/v3/sflow/setting

Element Attributes setting_attributes

Partition Visibility shared

Schema setting schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/sflow/setting	setting attributes
POST /axapi/v3/sflow/setting Payload: { "setting": { "max-header": 14 } }
Get Object	GET	/axapi/v3/sflow/setting	setting attributes
GET /axapi/v3/sflow/setting Reponse: { "setting": { "max-header": 14, "source-ip-use-mgmt": 0, "packet-sampling-rate": 1000, "counter-polling-interval": 20, "local-collection": "enable", "default-counter-polling-mtu": 1500, "append-mapping-info": 0, "uuid": "db247f28-6612-11d9-9a27-692335d4f00d", "a10-url": "/axapi/v3/sflow/setting" } }
Modify Object	POST	/axapi/v3/sflow/setting	setting attributes
Replace Object	PUT	/axapi/v3/sflow/setting	setting attributes
PUT /axapi/v3/sflow/setting Payload: { "setting": { "max-header": 15 } }
Delete Object	DELETE	/axapi/v3/sflow/setting	setting attributes
DELETE /axapi/v3/sflow/setting Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

setting attributes¶

append-mapping-info

Description Allow TPS to always send mapping ctr block (260, 271, and 272)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

counter-polling-interval

Description sFlow counter polling interval, default is 20

Type: number

Range: 1-200

Default: 20

default-counter-polling-mtu

Description Default MTU for counter-polling packets - DDoS 3.2 format only (Default: 1500)

Type: number

Range: 1200-1500

Default: 1500

local-collection

Description ‘enable’: Enable local sflow collection (Default); ‘disable’: Disable local sflow collection;

Type: string

Supported Values: enable, disable

Default: enable

local-t1-polling-interval

Description Set sFlow local counter polling interval for T1 stats

Type: number

Range: 1-18000

local-t2-polling-interval

Description Set sFlow local counter polling interval for T2 stats

Type: number

Range: 1-18000

management-link-utilization

Description limit management link speed in (Mbps)

Type: number

Range: 1-10000

Mutual Exclusion: management-link-utilization and management-link-utilization-percentage are mutually exclusive

management-link-utilization-percentage

Description percentage limit of the management link speed (Default is 30%)

Type: number

Range: 1-100

Default: 30

Mutual Exclusion: management-link-utilization-percentage and management-link-utilization are mutually exclusive

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

packet-sampling-rate

Description sFlow packet sampling rate, default is 1000

Type: number

Range: 10-10000

Default: 1000

port-range-end

Description Source port-range end

Type: number

Range: 2049-63640

port-range-start

Description Source port-range

Type: number

Range: 2049-63640

randomize-source-port

Description ‘enable’: Randomize source port; ‘disable’: Fix source port 6343; ‘packet-sampling-only’: Only randomized source port for packet-sampling (Default);

Type: string

Supported Values: enable, disable, packet-sampling-only

Default: packet-sampling-only

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