| prefix | vflow |
| namespace | urn:opendaylight:vtn:flow |
| revision | 2015-04-10 |
| description | The module that describes the data flow information established by the VTN Manager. |
| yang-version | 1 |
| imports | stat:opendaylight-statistics-types 2013-09-25; vaction:vtn-flow-action 2015-04-10; action:opendaylight-action-types 2013-11-12; inv:opendaylight-inventory 2013-08-19; vfcond:vtn-flow-condition 2015-03-13; flow:opendaylight-flow-types 2013-10-26; vtype:vtn-types 2015-02-09; |
| Name | Description |
|---|---|
| vtn-flow-id | Identifier for a VTN data flow. |
| virtual-route-reason | Describes the reason why the packet is forwarded to the virtual node. |
| data-flow-mode | Describes modes used to query information about data flow. |
| Name | Description |
|---|---|
| physical-route-info | Describes a pair of input and output switch port within the same physical switch. An instance of `physical-route-info' represents two physical ports in the same physical switch. The route of the packet in the physlcal network from the source to the destination physical switch port is represented by a sequence of `physical-route-info' instances. |
| vtn-data-flow-info | Describes a data flow established by the VTN Manager. |
| vtn-flow-identifiable | Describes an interface that specifies a VTN data flow. |
| averaged-flow-stats-fields | Describes the averaged flow statistics per second. |
| vtn-data-flow-common | Describes a common information about a data flow established by the VTN Manager. |
| virtual-route-info | This model is used to represent the virtual packet routing within the VTN. The route of the packet from the source to the destination virtual node is represented by a sequence of `virtual-route-info' instances. Note that this model may be empty if it indicates that the data flow is terminated without packet forwarding. |
| Name | Description |
|---|---|
| get-data-flow | Return information about data flows specified by the RPC input. The RPC input specifies the condition to select data flows to be returned. If more than one conditions are specified, data flows that meets all the specified conditions will be returned. If `flow-id' is specified, only a data flow specified by the flow ID will be selected. If `node' is specified, only data flows that forward packets via the specified switch will be selected. If `data-flow-port' is specified, only data flows that forward packets via the specified switch port will be selected. Note that `data-flow-port' field is ignored unless `node' field is specified. If `data-flow-source' is specified, only data flows that map packets sent by the specified L2 host will be selected. On successful completion, information about data flows specified by the RPC input is set to the RPC output. On failure, one of vtn-error-tag value which indicates the cause of error is set into application tag in RPC error. `BADREQUEST' is set if the RPC input contains invalid data. `NOTFOUND' is set if the specified VTN is not present. `INTERNALERROR' is set if the operation failed due to internal error. |
| get-data-flow-count | Return the number of data flows present in the specified VTN. On successful completion, the number of data flows is set to the RPC output. On failure, one of vtn-error-tag value which indicates the cause of error is set into application tag in RPC error. `BADREQUEST' is set if the RPC input contains invalid data. `NOTFOUND' is set if the specified VTN is not present. `INTERNALERROR' is set if the operation failed due to internal error. |