vtn-flow-filter

Base Information

prefix vfilter
namespace urn:opendaylight:vtn:flow:filter
revision 2015-09-07
description The module that describes the data models for flow filter, which provides packet filtering feature for packets forwarded in VTN.
yang-version 1
imports vtype:vtn-types 2015-02-09; vaction:vtn-flow-action 2015-04-10;

Groupings Summary

Name Description
vtn-redirect-filter-config Describes the configuration for the redirect flow filter.
vtn-flow-filter-result Describes pairs of flow filter indices and `vtn-update-type' values. This grouping is used as output of RPC that modifies the flow filter configuration.
vtn-flow-filter-list Describes a list of flow filters.
vtn-flow-filter-config Describes a rule of a packet filter applied to packets forwarded in VTN. If a flow condition configured in a flow filter matches a packet, flow actions configured in `actions' are applied to the packet in ascending order of `order' field in each action. - If `actions' is omitted or it is empty, the flow filter is applied to the packet without modifying the packet. - Actions in `actions' field will be evaluated in ascending order of `order' value. - Note that the VLAN ID of the packet cannot be modified by flow action because it is always determined by the virtual mapping configuration, such as port mapping. - `actions' is ignored if the type of the flow filter is `drop'. Only the following flow actions can be configured into `actions'. - `vtn-set-dl-src-action' - `vtn-set-dl-dst-action' - `vtn-set-vlan-pcp-action' - `vtn-set-inet-src-action' - `vtn-set-inet-dst-action' - `vtn-set-inet-dscp-action' - `vtn-set-port-src-action' - `vtn-set-port-dst-action' - `vtn-set-icmp-type-action' - `vtn-set-icmp-code-action'
vtn-flow-filter-id Specifies the target list of flow filters for RPC. If `tenant-name', `bridge-name', and `interface-name' is configured, the flow filter in the virtual interface attached to the vBridge is targeted. `output' field determines the flow direction for the flow filter. If `tenant-name' and `bridge-name' is configured and `interface-name' is omitted, the flow filter in the specified vBridge is targeted. `output' field determines the flow direction for the flow filter. If `tenant-name', `terminal-name', and `interface-name' is configured, the flow filter in the virtual interface attached to the vTerminal is targeted. `output' field determines the flow direction for the flow filter. If `tenant-name' is configured and `bridge-name', `terminal-name', and `interface-name' are omitted, the flow filter in the VTN is targeted. In this case `output' field is ignored because the VTN has a flow filter only for incoming packets. Otherwise RPC will fail.
vtn-flow-filter-type-fields Describes the type of flow filter.

RPCs Summary

Name Description
set-flow-filter Create or modify the flow filter. This operation takes a list of `vtn-flow-filter-config', and put all configurations into the flow filter list specified by `vtn-flow-filter-id' in the RPC input. Flow filter indices specified in the RPC input will be copied to the RPC output, and `status' field in `vtn-flow-filter-result' describes the result of the operation. Note that a duplicate flow filter index in the RPC input will cause a `BADREQUEST' error. `CREATED' indicates that new flow filter has been associated with the given index number in the specified flow filter list. `CHANGED' indicates that the flow filter specified by the given index number has been modified as specified by the RPC input. Null indicates that the flow filter specified by the given index was not changed. 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 virtual node which contains the specified flow filter list is not present. `INTERNALERROR' is set if the operation failed due to internal error.
remove-flow-filter Remove the specified flow filters. Index numbers for flow filters passed to `indices' list in the RPC input will be copied to the RPC output, and `status' field in the RPC output describes the result of the operation. `REMOVED' indicates that the flow filter specified by `index' field in the RPC output has been removed. Null indicates that the flow filter specified by `index' field is not present in the flow filter list specified by the RPC input. If no flow filter index is specified by the RPC input, all the flow filters in the specified flow filter list will be removed. In this case indices of all the removed flow filters will be copied to the RPC output. `flow-filter-result' in the RPC output will be null if no flow filter index is specified by the RPC input and the specified flow filter list is empty. 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 virtual node which contains the specified flow filter list is not present. `INTERNALERROR' is set if the operation failed due to internal error.

Groupings

RPC Definitions

set-flow-filter

remove-flow-filter