sflow

Configures, modifies, or retrieves sFlow configuration.

Resource URIs

URI Description
<base_URI>/config/running/sflow sFLow configuration.
GET URIs Description
<base_URI>/config/running/sflow Retrieves sFLow configuration.
<base_URI>/config/running/sflow/agent-address Retrieves sFLow agent-ID address.
<base_URI>/config/running/sflow/enable Retrieves if sFlow is enabled globally or not.
<base_URI>/config/running/sflow/source-interface Retrieves sFlow source IP interface.
<base_URI>/config/running/sflow//source-interface/interface-name Retrieves the sFlow interface information.
<base_URI>/config/running/sflow/collector/{collector-ip-address}/{collector-port-number}/{use-vrf} Retrieves sFlow collector configuration.
<base_URI>/config/running/sflow/polling-interval Retrieves interface counter polling interval details.
<base_URI>/config/running/sflow/sample-rate Retrieves interface sampling rate.
POST URIs Payload Description
<base_URI>/config/running/sflow <collector><collector-ip-address>{inet:ip-address}</collector-ip-address><collector-port-number>{uint32}</collector-port-number><use-vrf>{common-def:vrf-name}</use-vrf></collector> Configures sFlow collector.
PATCH URIs Payload Description
<base_URI>/config/running/sflow <sflow><enable>true</enable></sflow> Enables sFlow.
<base_URI>/config/running/sflow/source-interface <source-interface><interface-type>{source-interface-type}</interface-type><interface-name>{loopback:intf-loopback-port-type}</interface-name></source-interface> Confiugres sFlow source interface.
<base_URI>/config/running/sflow <sflow><polling-interval>{uint32}</polling-interval></sflow> Configures sFlow polling interval.
<base_URI>/config/running/sflow <sflow><sample-rate>{uint32}</sample-rate></sflow> Configures sFlow sampling rate.
PUT URIs Payload Description
<base_URI>/config/running/sflow <sflow><enable>true</enable></sflow> Enables sFlow.
<base_URI>/config/running/sflow/source-interface <source-interface><interface-type>{source-interface-type}</interface-type><interface-name>{loopback:intf-loopback-port-type}</interface-name></source-interface> Confiugres sFlow source interface.
<base_URI>/config/running/sflow/polling-interval <sflow><polling-interval>{uint32}</polling-interval></sflow> Configures sFlow polling interval.
<base_URI>/config/running/sflow/sample-rate <sflow><sample-rate>{uint32}</sample-rate></sflow> Configures sFlow sampling rate.
DELETE URIs
<base_URI>/config/running/sflow
<base_URI>/config/running/sflow/source-interface
<base_URI>/config/running/sflow/collector/{collector-ip-address}/{collector-port-number}/{use-vrf}
<base_URI>/config/running/sflow/polling-interval
<base_URI>/config/running/sflow/sample-rate

Parameters

collector-ip-address
Specifies the IP address of the sFlow collector.
collector-port-number
Specifies the port number used by the sFlow collector. The value can range from 1 through 65535.
use-vrf
VRF to use for sending data to the collector (default = mgmt-vrf).
source-ip
Specifies the source IP address to use.
polling-interval
Specifies polling interval value. The value can range from 1 through 65535. The default value is 20.
sample-rate
Specifies sampling rate value. The value can range from 2 through 16777215. The default value is 32768.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/sflow

None

<sflowurn:brocade.com:mgmt:brocade-sflow"" xmlns:y=""http://brocade.com/ns/rest"" y:self=""/rest/config/running/sflow"">
  <enable>true</enable>
  <source-interface y:self=""/rest/config/running/sflow/source-interface"">
  </source-interface>
  <collector y:self=""/rest/config/running/sflow/collector/34.1.1.2%2C6343%2Cvrf2"">
    <collector-ip-address>34.1.1.2</collector-ip-address>
    <collector-port-number>6343</collector-port-number>
    <use-vrf>vrf2</use-vrf>
  </collector>
  <collector y:self=""/rest/config/running/sflow/collector/112.1.1.2%2C6343%2Cdefault-vrf"">
    <collector-ip-address>112.1.1.2</collector-ip-address>
    <collector-port-number>6343</collector-port-number>
    <use-vrf>default-vrf</use-vrf>
  </collector>
  <collector y:self=""/rest/config/running/sflow/collector/172.22.12.83%2C6343%2Cmgmt-vrf"">
    <collector-ip-address>172.22.12.83</collector-ip-address>
    <collector-port-number>6343</collector-port-number>
    <use-vrf>mgmt-vrf</use-vrf>
  </collector>
  <collector y:self=""/rest/config/running/sflow/collector/fdd1:a123:b123:c123:34:1:1:2%2C6622%2Cvrf2"">
    <collector-ip-address>fdd1:a123:b123:c123:34:1:1:2</collector-ip-address>
    <collector-port-number>6622</collector-port-number>
    <use-vrf>vrf2</use-vrf>
  </collector>
  <collector y:self=""/rest/config/running/sflow/collector/fdd1:a123:b123:c123:112:1:1:2%2C6343%2Cdefault-vrf"">
    <collector-ip-address>fdd1:a123:b123:c123:112:1:1:2</collector-ip-address>
    <collector-port-number>6343</collector-port-number>
    <use-vrf>default-vrf</use-vrf>
  </collector>
  <polling-interval>44</polling-interval>
  <sample-rate>456</sample-rate>
</sflow>

URI

The following example uses the POST option to configure sFlow collector.

http://host:80/rest/config/running/sflow

<collector>
  <collector-ip-address>fdd1:a123:b123:c123:112:1:1:2</collector-ip-address>
  <collector-port-number>6343</collector-port-number>
  <use-vrf>default-vrf</use-vrf>
</collector>

None

URI

The following example uses the DELETE option to remove the sFlow sampling rate.

http://host:80/rest/config/running/sflow/sample-rate

None

None