sflow collector¶
Configure sFlow collector (a.k.a. receiver)
collector Specification¶
Parameter Value Type Intermediate Resource Element Name collector Element URI /axapi/v3/sflow/collector Element Attributes collector_attributes Partition Visibility shared Schema collector schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/sflow/collector | collector_attributes |
collector attributes¶
custom-list
Type: List
Reference Object: /axapi/v3/sflow/collector/custom/{name}
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}
custom-list¶
Specification Value Type list Block object keys ipv4_addr
Description Configure IP address of the sFlow Receiver
Type: string
Format: ipv4-address
ipv6_addr
Description Configure IPv6 address of the sFlow Receiver
Type: string
Format: ipv6-address
name
Description Configure name of sFlow Receiver
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-list¶
Specification Value Type list Block object keys addr
Description Configure sFlow collector IP address
Type: string
Format: ipv4-address
customized-setting
Description: customized-setting is a JSON Block. Please see below for ip-list_customized-setting
Type: Object
Reference Object: /axapi/v3/sflow/collector/ip/{addr}+{port}/customized-setting
port
Description Port number (default is 6343)
Type: number
Range: 1-65535
Default: 6343
use-mgmt-port
Description sFlow collector is through out-of-band management
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ip-list_customized-setting¶
Specification Value Type object a10-proprietary-polling
Description Enable counters for ACOS control blocks
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
counter-polling
Description Enable counter polling
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
event-notification
Description Enable event notification
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
export-enable
Description ‘export’: Export settings;
Type: string
Supported Values: export
packet-sampling
Description Enable packet sampling
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
ipv6-list¶
Specification Value Type list Block object keys addr
Description Configure sFlow collector IPv6 address
Type: string
Format: ipv6-address
customized-setting
Description: customized-setting is a JSON Block. Please see below for ipv6-list_customized-setting
Type: Object
Reference Object: /axapi/v3/sflow/collector/ipv6/{addr}+{port}/customized-setting
port
Description Port number (default is 6343)
Type: number
Range: 1-65535
Default: 6343
use-mgmt-port
Description sFlow collector is through out-of-band management
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ipv6-list_customized-setting¶
Specification Value Type object a10-proprietary-polling
Description Enable counters for ACOS control blocks
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
counter-polling
Description Enable counter polling
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
event-notification
Description Enable event notification
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
export-enable
Description ‘export’: Customizes export settings for collector;
Type: string
Supported Values: export
packet-sampling
Description Enable packet sampling
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