< Home

Data Model

The configuration model file matching NetStream is huawei-netstream.yang.

Only the following switch models support NetStream:

S5720-HI, S5730-HI, S5731-H, S5731-S, S5731S-H, S5731S-S, S5732-H, S6720-HI, S6730-H, S6730S-H, S6730-S, S6730S-S

Table 1 Configuration objects of NetStream

Object

Description

Value

Remarks

/huawei-netstream:netstream-policy/sample-rule/name

Indicates the name of a flexible flow statistics template.

The value is a string of 1 to 32 case-insensitive characters without spaces. The name of the flexible flow statistics template cannot contain the following special characters: / \ : * ? " < > | @ ' %.

To modify or delete a flexible flow statistics template that has been applied to an interface, delete the /huawei-netstream:netstream-apply/interface/record-applys/record-apply/record-name object first.

/huawei-netstream:netstream-policy/sample-rule/record-info/match-field-bits

Configures aggregation keywords for flexible flow statistics.

The value is of the enumerated type:

  • destination-address: aggregates statistics based on the destination IP address.
  • source-address: aggregates statistics based on the source IP address.
  • destination-port: aggregates statistics based on the destination port number.
  • source-port: aggregates statistics based on the source port number.
  • protocol: aggregates statistics based on the protocol type.
  • flow-label: aggregates statistics based on the IPv6 flow label.
  • dscp: aggregates statistics based on the DSCP priority.
  • ttl: aggregates statistics based on the TTL value.
  • destination-mac: aggregates statistics based on the destination MAC address.
  • source-mac: aggregates statistics based on the source MAC address.
  • vlan: aggregates statistics based on the VLAN ID.
  • in-direction: aggregates statistics about incoming packets on an interface.
  • out-direction: aggregates statistics about outgoing packets on an interface.
  • If multiple aggregation keywords are specified at a time, separate them with spaces, for example, destination-address source-address destination-port.
  • in-direction and out-direction can only be configured together with vlan, destination-mac, or source-mac. In addition, in-direction and out-direction cannot be configured in the same flexible flow statistics template.

/huawei-netstream:netstream-policy/sample-rule/record-info/collect-field-bits

Configures types of information included in flexible flow statistics.

The value is of the enumerated type:

  • packets: indicates that flexible flow statistics contain the number of packets.
  • bytes: indicates that flexible flow statistics contain the number of bytes.
  • input: indicates that flexible flow statistics contain the index of the inbound interface.
  • output: indicates that flexible flow statistics contain the index of the outbound interface.
  • tcp-flag: indicates that flexible flow statistics contain TCP flags of a flow.

If multiple information types are specified at a time, separate them with spaces.

/huawei-netstream:netstream-policy/export-source/ip

Specifies the source IPv4 address of the exported packets carrying IPv4 flow statistics.

The value must be a valid IPv4 address in dotted decimal notation.

  • The IPv4 address cannot belong to the 0.0.0.0-0.255.255.255, 127.0.0.0-127.255.255.255, or 224.0.0.0-255.255.255.255 network segment.
  • The IP address specified by export-host-no-vpn is a public IP address, and the IP address specified by export-host-vpn belongs to a VPN.
  • The IPv4 addresses specified under the /huawei-netstream:netstream-policy object are global IPv4 addresses, which apply to original flows, flexible flows, and aggregation flows. The IPv4 addresses specified under the /huawei-netstream:netstream-policy/aggregation object apply only to aggregation flows. When IPv4 addresses are configured under both of the objects, the global address is used for original flows and flexible flows, and the IP address configured under /huawei-netstream:netstream-policy/aggregation is used for aggregation flows.

/huawei-netstream:netstream-policy/export-host-no-vpn

Specifies the destination IPv4 address and destination UDP port number of the exported packets carrying IPv4 flow statistics. The following sub-objects must be configured:

  • ip: specifies the destination IPv4 address.
  • port: specifies the destination UDP port number.

The values of sub-objects are as follows:

  • ip: The value must be a valid IPv4 address in dotted decimal notation.
  • port: The value is an integer in the range from 1 to 65535.

/huawei-netstream:netstream-policy/export-host-vpn

Specifies the destination IPv4 address and destination UDP port number of the exported packets carrying IPv4 flow statistics. The following sub-objects must be configured:

  • ip: specifies the destination IPv4 address.
  • port: specifies the destination UDP port number.
  • vpn-instance-name: specifies the VPN instance to which the destination IPv4 address belongs.

The values of sub-objects are as follows:

  • ip: The value must be a valid IPv4 address in dotted decimal notation.
  • port: The value is an integer in the range from 1 to 65535.
  • vpn-instance-name: The value must be the name of an existing VPN instance enabled with the IPv4 address family.

/huawei-netstream:netstream-policy/export-timeout/active-timeout

Specifies the active flow aging time.

The value is an integer in the range from 1 to 300, in seconds. The default value is 200.

N/A

/huawei-netstream:netstream-policy/export-timeout/inactive-timeout

Specifies the inactive flow aging time.

The value is an integer in the range from 1 to 300, in seconds. The default value is 30.

N/A

/huawei-netstream:netstream-policy/export-version-details/version

Specifies the version number of the exported packets carrying IPv4 flow statistics.

The value is of the enumerated type:

  • version_5
  • version_9

By default, the versions of the exported packets carrying IPv4 original flow statistics and IPv4 flexible flow statistics are version 5 and version 9, respectively.

N/A

/huawei-netstream:netstream-policy/export-version-details/auto-system-type

Specifies the AS option of the exported packets carrying IPv4 flow statistics.

The value is of the enumerated type:

  • origin-as: specifies the AS number recorded in the exported packets carrying IPv4 flow statistics as the original AS number.
  • peer-as: specifies the AS number recorded in the exported packets carrying IPv4 flow statistics as the peer AS number.

By default, exported packets carrying IPv4 flow statistics have no AS option.

This object must be configured together with the /huawei-netstream:netstream-policy/export-version-details/version object.

/huawei-netstream:netstream-policy/export-version-details/bgp-nexthop

Configures whether exported packets carrying IPv4 flow statistics contain BGP next hop information.

The value is of the Boolean type:

  • true: Exported packets carrying IPv4 flow statistics contain BGP next hop information.
  • false: Exported packets carrying IPv4 flow statistics do not contain BGP next hop information.

The default value is false.

Only exported packets of version 9 that carry IPv4 flow statistics can contain BGP next hop information.

/huawei-netstream:netstream-policy/export-index-switch

Specifies the number of bits of the interface index in the exported packets carrying IPv4 flow statistics.

The value is an integer, which can be 16 or 32. The default value is 16.

  • When only packets of version 9 are exported, the value of this object can be set to 32.
  • After the value of this object is set to 32, the version number of exported packets cannot be changed to 5.

/huawei-netstream:netstream-policy/tcp-flag

Indicates whether the aging of NetStream traffic according to the FIN flag or the RST flag in the TCP packet header is enabled.

The value is of the Boolean type:

  • true: The function is enabled.
  • false: The function is disabled.

The default value is false.

N/A

/huawei-netstream:netstream-policy/aggregation/aggregation-type

Specifies the aggregation method of aggregation flow statistics.

The value is of the enumerated type:

  • as: AS aggregation
  • as-tos: AS-ToS aggregation
  • destination-prefix: destination-prefix aggregation
  • destination-prefix-tos: destination-prefix-ToS aggregation
  • prefix: prefix aggregation
  • prefix-tos: prefix-ToS aggregation
  • protocol-port: protocol-port aggregation
  • protocol-port-tos: protocol-port-ToS aggregation
  • source-prefix: source-prefix aggregation
  • source-prefix-tos: source-prefix-ToS aggregation

N/A

/huawei-netstream:netstream-policy/aggregation/enable

Whether to enable the aggregation function.

To enable the aggregation function, enter a space.

The aggregation function must be enabled. Otherwise, the aggregation mode does not take effect.

/huawei-netstream:netstream-policy/aggregation/aggregation-export-source/ip

Specifies the source IPv4 address of the exported packets carrying IPv4 aggregation flow statistics.

The value must be a valid IPv4 address in dotted decimal notation.

  • The IPv4 address cannot belong to the 0.0.0.0-0.255.255.255, 127.0.0.0-127.255.255.255, or 224.0.0.0-255.255.255.255 network segment.
  • The IP address specified by aggregation-export-host-no-vpn is a public IP address, and the IP address specified by aggregation-export-host-vpn belongs to a VPN.
  • The IPv4 addresses specified under the /huawei-netstream:netstream-policy object are global IPv4 addresses, which apply to original flows, flexible flows, and aggregation flows. The IPv4 addresses specified under the /huawei-netstream:netstream-policy/aggregation object apply only to aggregation flows. When IPv4 addresses are configured under both of the objects, the global address is used for original flows and flexible flows, and the IP address configured under /huawei-netstream:netstream-policy/aggregation is used for aggregation flows.

/huawei-netstream:netstream-policy/aggregation/aggregation-export-host-no-vpn

Specifies the destination IPv4 address and destination UDP port number of the exported packets carrying IPv4 aggregation flow statistics. The following sub-objects must be configured:

  • ip: specifies the destination IPv4 address.
  • port: specifies the destination UDP port number.

The values of sub-objects are as follows:

  • ip: The value must be a valid IPv4 address in dotted decimal notation.
  • port: The value is an integer in the range from 1 to 65535.

/huawei-netstream:netstream-policy/aggregation/aggregation-export-host-vpn

Specifies the destination IPv4 address and destination UDP port number of the exported packets carrying IPv4 aggregation flow statistics. The following sub-objects must be configured:

  • ip: specifies the destination IPv4 address.
  • port: specifies the destination UDP port number.
  • vpn-instance-name: specifies the VPN instance to which the destination IPv4 address belongs.

The values of sub-objects are as follows:

  • ip: The value must be a valid IPv4 address in dotted decimal notation.
  • port: The value is an integer in the range from 1 to 65535.
  • vpn-instance-name: The value must be the name of an existing VPN instance enabled with the IPv4 address family.

/huawei-netstream:netstream-policy/aggregation/aggregation-export-version

Specifies the version number of exported packets carrying IPv4 aggregation flow statistics.

The value is an integer, which can be 8 or 9. The default value is 8.

Version 9 is supported by most NetStream servers because of its advantages such as template-based, easy expansion, and flexible output. It is recommended that you set the version of exported packets carrying IPv4 aggregation flow statistics to version 9.

/huawei-netstream:netstream-policy/aggregation/aggregation-template-timeout/template-timeout

Specifies the interval at which the switch sends the NetStream export template to the NetStream server when IPv4 aggregation flow statistics are exported in NetStream version 9.

The value is an integer in the range from 1 to 3600, in minutes. The default value is 30.

N/A

/huawei-netstream:netstream-policy/aggregation/aggregation-source-mask

Specifies the length of the aggregation mask for the source address.

The value is an integer in the range from 1 to 32.

This object is used in the following aggregation methods: prefix, prefix-ToS, source-prefix, and source-prefix-ToS.

/huawei-netstream:netstream-policy/aggregation/aggregation-destination-mask

Specifies the length of the aggregation mask for the destination address.

The value is an integer in the range from 1 to 32.

This object is used in the following aggregation methods: prefix, prefix-ToS, destination-prefix, and destination-prefix-ToS.

/huawei-netstream:netstream-policy/export-template-timeout/template-timeout

Specifies the interval at which the switch sends the NetStream export template to the NetStream server when IPv4 original or flexible flow statistics are exported in NetStream version 9.

The value is an integer in the range from 1 to 3600, in minutes. The default value is 30.

N/A

/huawei-netstream:netstream-policy/ipv6-export-source/ip

Specifies the source IPv4 address of exported packets carrying IPv6 flow statistics.

The value must be a valid IPv4 address in dotted decimal notation.

  • The IPv4 address cannot belong to the 0.0.0.0-0.255.255.255, 127.0.0.0-127.255.255.255, or 224.0.0.0-255.255.255.255 network segment.
  • The IP address specified by ipv6-export-host-no-vpn is a public IP address, and the IP address specified by ipv6-export-host-vpn belongs to a VPN.

/huawei-netstream:netstream-policy/ipv6-export-host-no-vpn

Specifies the destination IPv4 address and destination UDP port number of the exported packets carrying IPv6 flow statistics. The following sub-objects must be configured:

  • ip: specifies the destination IPv4 address.
  • port: specifies the destination UDP port number.

The values of sub-objects are as follows:

  • ip: The value must be a valid IPv4 address in dotted decimal notation.
  • port: The value is an integer in the range from 1 to 65535.

/huawei-netstream:netstream-policy/ipv6-export-host-vpn

Specifies the destination IPv4 address and destination UDP port number of the exported packets carrying IPv6 flow statistics. The following sub-objects must be configured:

  • ip: specifies the destination IPv4 address.
  • port: specifies the destination UDP port number.
  • vpn-instance-name: specifies the VPN instance to which the destination IPv4 address belongs.

The values of sub-objects are as follows:

  • ip: The value must be a valid IPv4 address in dotted decimal notation.
  • port: The value is an integer in the range from 1 to 65535.
  • vpn-instance-name: The value must be the name of an existing VPN instance enabled with the IPv4 address family.

/huawei-netstream:netstream-policy/ipv6-export-index-switch

Specifies the number of bits of the interface index in the exported packets carrying IPv6 flow statistics.

The value is of the enumerated type:

  • sixteen
  • thirty-two

The default value is sixteen.

N/A

/huawei-netstream:netstream-policy/ipv6-export-version/version

Specifies the version number of the exported packets carrying IPv6 flow statistics.

Currently, the value can only be version_9.

N/A

/huawei-netstream:netstream-policy/ipv6-export-version/auto-system-type

Specifies the AS option of the exported packets carrying IPv6 flow statistics.

The value is of the enumerated type:

  • origin-as: specifies the AS number recorded in the exported packets carrying IPv6 flow statistics as the original AS number.
  • peer-as: specifies the AS number recorded in the exported packets carrying IPv6 flow statistics as the peer AS number.

By default, exported packets carrying IPv6 flow statistics have no AS option.

N/A

/huawei-netstream:reset-netstream/input/reset-bits

Forcibly ages all flows in the cache or clears flow statistics.

The value is of the enumerated type:

  • reset-cache: forcibly ages all flows in the cache.
  • reset-statistic: clears flow statistics.
  • reset-cache reset-statistic: forcibly ages all flows in the cache and clears NetStream flow statistics.

This object takes effect only when it is configured together with the /huawei-netstream:reset-netstream/input/slot object.

/huawei-netstream:reset-netstream/input/slot

Specifies a slot ID.

The value depends on the device configuration.

N/A

/huawei-netstream:refresh-netstream

Indicates whether the switch is configured to send the NetStream export template to the NetStream server immediately.

To enable the switch to send the NetStream export template to the NetStream server immediately, perform the send <refresh-netstream> RPC operation on this object.

This function is supported only when the version number of exported packets carrying flow statistics is 9.

/huawei-netstream:netstream-apply/interface/name

Specifies the interface enabled with NetStream.

The value is a string of characters in the format of interface-typeinterface-number. The interface must exist on the switch.

Before configuring this object, configure /ietf-interfaces:interfaces-state/interface/name first.

/huawei-netstream:netstream-apply/interface/record-applys/record-apply

Applies a specified flexible flow statistics template to an interface. The following sub-objects must be configured:

  • direction: specifies the direction in which a flexible flow statistics template is applied.
  • record-name: specifies the name of a flexible flow statistics template to be applied.

The values of sub-objects are as follows:

  • direction: inbound or outbound
  • record-name: name of an existing flexible flow statistics template

To cancel the flexible flow statistics template applied to an interface, perform the delete operation on the parent object.

  • If a direction is specified, the flexible flow statistics template applied in the specified direction is canceled.
  • If no direction is specified, the flexible flow statistics templates applied in the inbound and outbound directions are canceled.

/huawei-netstream:netstream-apply/interface/packets-samples/packets-sample

Specifies an IPv4 packet sampling rate. The following sub-objects must be configured:

  • direction: specifies the direction of packets to be sampled.
  • fix-packets: specifies a sampling rate.

The values of sub-objects are as follows:

  • direction: inbound or outbound
  • fix-packets: The value is an integer in the range from 1 to 65535. The default value is 1000.

N/A

/huawei-netstream:netstream-apply/interface/ns-enable/direction

Specifies the direction of IPv4 traffic for which NetStream flow statistics collection is enabled on an interface.

The value is of the enumerated type:

  • inbound
  • outbound

By default, NetStream flow statistics collection is disabled for both incoming and outgoing IPv4 traffic on an interface.

To disable NetStream flow statistics collection on an interface, perform the delete operation on the parent object.

  • If a direction is specified, NetStream flow statistics collection is disabled for traffic in the specified direction.
  • If no direction is specified, NetStream flow statistics collection is disabled for traffic in both the inbound and outbound directions.

/huawei-netstream:netstream-apply/interface/ipv6-ns-enable/direction

Specifies the direction of IPv6 traffic for which NetStream flow statistics collection is enabled on an interface.

The value is of the enumerated type:

  • inbound
  • outbound

By default, NetStream flow statistics collection is disabled for both incoming and outgoing IPv6 traffic on an interface.

/huawei-netstream:netstream-apply/interface/ipv6-packets-sample

Specifies an IPv6 packet sampling rate. The following sub-objects must be configured:

  • direction: specifies the direction of packets to be sampled.
  • fix-packets: specifies a sampling rate.

The values of sub-objects are as follows:

  • direction: inbound or outbound
  • fix-packets: The value is an integer in the range from 1 to 65535. The default value is 1000.

N/A

Copyright © Huawei Technologies Co., Ltd.
Copyright © Huawei Technologies Co., Ltd.
Next topic >