vtn-flow-condition

Base Information

prefix	vfcond
namespace	urn:opendaylight:vtn:flow:cond
revision	2015-03-13
description	The module that describes the flow condition to match against packets.
yang-version	1
imports	inet:ietf-inet-types 2010-09-24; vtype:vtn-types 2015-02-09; yang:ietf-yang-types 2010-09-24; l2:opendaylight-l2-types 2013-08-27;

Groupings Summary

Name	Description
vtn-icmp-match-fields	Describes the ICMP header fields to match against packets.
vtn-match-fields	Describes the configuration for a VTN flow match that specifies the condition to match against packets.
vtn-ether-match-fields	Describes the ethernet header and IEEE 802.1Q VLAN tag fields to match against packets.
vtn-flow-match-config	Describes the configuration for a VTN flow match in a VTN flow condition.
vtn-tcp-match-fields	Describes the range of TCP port numbers.
vtn-port-range	Describes the range of IP transport layer protocol such as TCP.
vtn-udp-match-fields	Describes the range of UDP port numbers.
vtn-inet-match-fields	Describes the IP header fields to match against packets.
vtn-flow-match-result	Describes a pair of VTN flow match index and `vtn-update-type'. This grouping is used as output of RPC that modifies the VTN flow match configuration in a flow condition.
vtn-flow-cond-config	Describes the configuration for a VTN flow condition.

Child Nodes Summary

Name	Description
vtn-flow-conditions	The root container of all the flow condition configuratins. Note that the flow condition configuration must be modified by RPC. Do not edit this container directly.

RPCs Summary

Name	Description
set-flow-condition	Create or modify the flow condition. If the flow condition specified by the name does not exist, a new flow condition will be associated with the specified name. If the flow condition specifie dby the name already exists, it will be modified as specified the RPC input. `status' in RPC output descripts the result of the operation. `CREATED' indicates that the specified flow condition has been newly created. `CHANGED' indicates that existing flow condition configuraiton has been successfully changed. Null indicates that existing flow condition configuration has not been 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 true is set to `present' field in the RPC input and the target flow condition is not present. `INTERNALERROR' is set if the operation failed due to internal error.
clear-flow-condition	Remove all the flow conditions. `status' in RPC output descripts the result of the operation. `REMOVED' indicates that at least one flow condition has been removed. Null indicates that no flow condition is present. On failure, one of vtn-error-tag value which indicates the cause of error is set into application tag in RPC error. `INTERNALERROR' is set if the operation failed due to internal error.
set-flow-condition-match	Configure a flow match condition into the flow condition specified by the flow condition name and match index. This operation takes a list of `vtn-flow-match-config', and put all configurations in that list into the specified flow condition. Match indices specified in the RPC input will be copied to the RPC output, and `status' field in `vtn-flow-match-result' describes the result of the operation. `CREATED` indicates that the flow match configuration specified by the index value has been newly created. `CHANGED' indicates that the flow match configuration specified by the index value has been successfully changed. Null indicates that the flow match configuration specified by the index value 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 specified flow condition is not present. `INTERNALERROR' is set if the operation failed due to internal error.
remove-flow-condition	Remove the flow condition specified by the name. 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 flow condition is not present. `INTERNALERROR' is set if the operation failed due to internal error.
remove-flow-condition-match	Remove the flow match condition specified by the flow condition name and match index. Values passed to `match-index' list will be copied to the RPC output, and `status' field in `vtn-flow-match-result' describes the result of the operation. `REMOVED' indicates that the flow match associated with the match index has been successfully removed. Null indicates that the flow match is not associated with the match index in the specified flow condition. 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 flow condition is not present. `INTERNALERROR' is set if the operation failed due to internal error.

Groupings

vtn-icmp-match-fields
- Description: Describes the ICMP header fields to match against packets.
vtn-match-fields
- Description: Describes the configuration for a VTN flow match that specifies the condition to match against packets.
vtn-ether-match-fields
- Description: Describes the ethernet header and IEEE 802.1Q VLAN tag fields to match against packets.
vtn-flow-match-config
- Description: Describes the configuration for a VTN flow match in a VTN flow condition.
vtn-tcp-match-fields
- Description: Describes the range of TCP port numbers.
vtn-port-range
- Description: Describes the range of IP transport layer protocol such as TCP.
vtn-udp-match-fields
- Description: Describes the range of UDP port numbers.
vtn-inet-match-fields
- Description: Describes the IP header fields to match against packets.
vtn-flow-match-result
- Description: Describes a pair of VTN flow match index and `vtn-update-type'. This grouping is used as output of RPC that modifies the VTN flow match configuration in a flow condition.
vtn-flow-cond-config
- Description: Describes the configuration for a VTN flow condition.

Datastore Structure

vtn-flow-condition

vtn-flow-conditions
- vtn-flow-condition [name]
  - name(U)
  - vtn-flow-match [index] (U)
    - index(U)
    - vtn-ether-match(U)
      - source-address(U)
      - destination-address(U)
      - ether-type(U)
      - vlan-id(U)
      - vlan-pcp(U)
    - vtn-inet-match(U)
      - source-network(U)
      - destination-network(U)
      - protocol(U)
      - dscp(U)
    - vtn-layer4-match(U) (choice)
      - vtn-icmp-match(U)
        
        icmp-type(U)
        
        icmp-code(U)
      - vtn-tcp-match(U)
        
        tcp-source-range(U)
        
        port-from(U)
        
        port-to(U)
        
        tcp-destination-range(U)
        
        port-from(U)
        
        port-to(U)
      - vtn-udp-match(U)
        
        udp-source-range(U)
        
        port-from(U)
        
        port-to(U)
        
        udp-destination-range(U)
        
        port-from(U)
        
        port-to(U)

Child nodes

Direct children

vtn-flow-conditions (container)
- configuration data: false

vtn-flow-conditions

XML Path
Restconf path: vtn-flow-condition:vtn-flow-conditions

Direct children

vtn-flow-condition (list)
- configuration data: false

XML example

        <vtn-flow-conditions xmlns="urn:opendaylight:vtn:flow:cond">
        
            <!-- See definition
             for child nodes.  -->
            <!-- This node could appear multiple times -->
            <vtn-flow-condition xmlns="urn:opendaylight:vtn:flow:cond">...</vtn-flow-condition>
        
        </vtn-flow-conditions>

vtn-flow-conditions/vtn-flow-condition

XML Path
Restconf path: vtn-flow-condition:vtn-flow-conditions/vtn-flow-condition/{name}

Direct children

name (leaf)
- configuration data: false
- mandatory: false
vtn-flow-match (list)
- configuration data: false

XML example

        <vtn-flow-condition xmlns="urn:opendaylight:vtn:flow:cond">
        
            <name xmlns="urn:opendaylight:vtn:flow:cond">...</name>
        
            <!-- See definition
             for child nodes.  -->
            <!-- This node could appear multiple times -->
            <vtn-flow-match xmlns="urn:opendaylight:vtn:flow:cond">...</vtn-flow-match>
        
        </vtn-flow-condition>

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match

XML Path
Restconf path: vtn-flow-condition:vtn-flow-conditions/vtn-flow-condition/{name}/vtn-flow-match/{index}

Direct children

index (leaf)
- configuration data: false
- mandatory: false
vtn-ether-match (container)
- configuration data: false
vtn-inet-match (container)
- configuration data: false

XML example

        <vtn-flow-match xmlns="urn:opendaylight:vtn:flow:cond">
        
            <index xmlns="urn:opendaylight:vtn:flow:cond">...</index>
        
            <!-- See definition
             for child nodes.  -->
            <vtn-ether-match xmlns="urn:opendaylight:vtn:flow:cond">...</vtn-ether-match>
        
            <!-- See definition
             for child nodes.  -->
            <vtn-inet-match xmlns="urn:opendaylight:vtn:flow:cond">...</vtn-inet-match>
        
            
        
        </vtn-flow-match>

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/vtn-ether-match

XML Path
Restconf path: vtn-flow-condition:vtn-flow-conditions/vtn-flow-condition/{name}/vtn-flow-match/{index}/vtn-ether-match

Direct children

source-address (leaf)
- configuration data: false
- mandatory: false
destination-address (leaf)
- configuration data: false
- mandatory: false
ether-type (leaf)
- configuration data: false
- mandatory: false
vlan-id (leaf)
- configuration data: false
- mandatory: false
vlan-pcp (leaf)
- configuration data: false
- mandatory: false

XML example

        <vtn-ether-match xmlns="urn:opendaylight:vtn:flow:cond">
        
            <source-address xmlns="urn:opendaylight:vtn:flow:cond">...</source-address>
        
            <destination-address xmlns="urn:opendaylight:vtn:flow:cond">...</destination-address>
        
            <ether-type xmlns="urn:opendaylight:vtn:flow:cond">...</ether-type>
        
            <vlan-id xmlns="urn:opendaylight:vtn:flow:cond">...</vlan-id>
        
            <vlan-pcp xmlns="urn:opendaylight:vtn:flow:cond">...</vlan-pcp>
        
        </vtn-ether-match>

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/vtn-inet-match

XML Path
Restconf path: vtn-flow-condition:vtn-flow-conditions/vtn-flow-condition/{name}/vtn-flow-match/{index}/vtn-inet-match

Direct children

source-network (leaf)
- configuration data: false
- mandatory: false
destination-network (leaf)
- configuration data: false
- mandatory: false
protocol (leaf)
- configuration data: false
- mandatory: false
dscp (leaf)
- configuration data: false
- mandatory: false

XML example

        <vtn-inet-match xmlns="urn:opendaylight:vtn:flow:cond">
        
            <source-network xmlns="urn:opendaylight:vtn:flow:cond">...</source-network>
        
            <destination-network xmlns="urn:opendaylight:vtn:flow:cond">...</destination-network>
        
            <protocol xmlns="urn:opendaylight:vtn:flow:cond">...</protocol>
        
            <dscp xmlns="urn:opendaylight:vtn:flow:cond">...</dscp>
        
        </vtn-inet-match>

XML example

        <vtn-flow-match xmlns="urn:opendaylight:vtn:flow:cond">
        
            
        
            
        
            
        
        </vtn-flow-match>

Direct children

tcp-source-range (container)
- configuration data: false
tcp-destination-range (container)
- configuration data: false

XML example

        <vtn-flow-match xmlns="urn:opendaylight:vtn:flow:cond">
        
            <!-- See definition
             for child nodes.  -->
            <tcp-source-range xmlns="urn:opendaylight:vtn:flow:cond">...</tcp-source-range>
        
            <!-- See definition
             for child nodes.  -->
            <tcp-destination-range xmlns="urn:opendaylight:vtn:flow:cond">...</tcp-destination-range>
        
        </vtn-flow-match>

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/tcp-source-range

XML Path
Restconf path: vtn-flow-condition:vtn-flow-conditions/vtn-flow-condition/{name}/vtn-flow-match/{index}/tcp-source-range

Direct children

port-from (leaf)
- configuration data: false
- mandatory: true
port-to (leaf)
- configuration data: false
- mandatory: false

XML example

        <tcp-source-range xmlns="urn:opendaylight:vtn:flow:cond">
        
            <port-from xmlns="urn:opendaylight:vtn:flow:cond">...</port-from>
        
            <port-to xmlns="urn:opendaylight:vtn:flow:cond">...</port-to>
        
        </tcp-source-range>

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/tcp-destination-range

XML Path
Restconf path: vtn-flow-condition:vtn-flow-conditions/vtn-flow-condition/{name}/vtn-flow-match/{index}/tcp-destination-range

Direct children

port-from (leaf)
- configuration data: false
- mandatory: true
port-to (leaf)
- configuration data: false
- mandatory: false

XML example

        <tcp-destination-range xmlns="urn:opendaylight:vtn:flow:cond">
        
            <port-from xmlns="urn:opendaylight:vtn:flow:cond">...</port-from>
        
            <port-to xmlns="urn:opendaylight:vtn:flow:cond">...</port-to>
        
        </tcp-destination-range>

Direct children

icmp-type (leaf)
- configuration data: false
- mandatory: false
icmp-code (leaf)
- configuration data: false
- mandatory: false

XML example

        <vtn-flow-match xmlns="urn:opendaylight:vtn:flow:cond">
        
            <icmp-type xmlns="urn:opendaylight:vtn:flow:cond">...</icmp-type>
        
            <icmp-code xmlns="urn:opendaylight:vtn:flow:cond">...</icmp-code>
        
        </vtn-flow-match>

Direct children

udp-source-range (container)
- configuration data: false
udp-destination-range (container)
- configuration data: false

XML example

        <vtn-flow-match xmlns="urn:opendaylight:vtn:flow:cond">
        
            <!-- See definition
             for child nodes.  -->
            <udp-source-range xmlns="urn:opendaylight:vtn:flow:cond">...</udp-source-range>
        
            <!-- See definition
             for child nodes.  -->
            <udp-destination-range xmlns="urn:opendaylight:vtn:flow:cond">...</udp-destination-range>
        
        </vtn-flow-match>

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/udp-source-range

XML Path
Restconf path: vtn-flow-condition:vtn-flow-conditions/vtn-flow-condition/{name}/vtn-flow-match/{index}/udp-source-range

Direct children

port-from (leaf)
- configuration data: false
- mandatory: true
port-to (leaf)
- configuration data: false
- mandatory: false

XML example

        <udp-source-range xmlns="urn:opendaylight:vtn:flow:cond">
        
            <port-from xmlns="urn:opendaylight:vtn:flow:cond">...</port-from>
        
            <port-to xmlns="urn:opendaylight:vtn:flow:cond">...</port-to>
        
        </udp-source-range>

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/udp-destination-range

XML Path
Restconf path: vtn-flow-condition:vtn-flow-conditions/vtn-flow-condition/{name}/vtn-flow-match/{index}/udp-destination-range

Direct children

port-from (leaf)
- configuration data: false
- mandatory: true
port-to (leaf)
- configuration data: false
- mandatory: false

XML example

        <udp-destination-range xmlns="urn:opendaylight:vtn:flow:cond">
        
            <port-from xmlns="urn:opendaylight:vtn:flow:cond">...</port-from>
        
            <port-to xmlns="urn:opendaylight:vtn:flow:cond">...</port-to>
        
        </udp-destination-range>

RPC Definitions

set-flow-condition

Description: Create or modify the flow condition. If the flow condition specified by the name does not exist, a new flow condition will be associated with the specified name. If the flow condition specifie dby the name already exists, it will be modified as specified the RPC input. `status' in RPC output descripts the result of the operation. `CREATED' indicates that the specified flow condition has been newly created. `CHANGED' indicates that existing flow condition configuraiton has been successfully changed. Null indicates that existing flow condition configuration has not been 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 true is set to `present' field in the RPC input and the target flow condition is not present. `INTERNALERROR' is set if the operation failed due to internal error.

container: input

min elements: 0
max elements: 2147483647

uses: vtn-flow-cond-config

refines:

leaf: name

description: The name of the flow condition.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:vtn:types)vnode-name

list: vtn-flow-match

description: A list of conditions to match against packets. Each element in this list needs to have a unique index value in `index' field. If more than one match elements are configured, they are evaluated against packets in ascending order of `index' value in each match element. Packets which matches the condition described by at least one match element are selected by this flow condition. Every packet is selected if this element is omitted or empty.
min elements: 0
max elements: 2147483647
key definition: index

uses: vtn-flow-match-config

refines:

leaf: index

description: The index value that determines the order of elements in a list.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:vtn:types)int32

container: vtn-ether-match

description: The flow condition to match against Ethernet header.
min elements: 0
max elements: 2147483647

uses: vtn-ether-match-fields

refines:

leaf: source-address

description: The source MAC address.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address

leaf: destination-address

description: The destination MAC address.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address

leaf: ether-type

description: The ethernet type.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:l2:types)ether-type

leaf: vlan-id

description: The VLAN ID in VLAN tag. Zero means untagged ethernet frame.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:l2:types)vlan-id

leaf: vlan-pcp

description: The VLAN priority in VLAN tag.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:l2:types)vlan-pcp

container: vtn-inet-match

description: The flow condition to match against IP header.
min elements: 0
max elements: 2147483647

uses: vtn-inet-match-fields

refines:

leaf: source-network

description: The IP network to match the source IP address. Currently, it is possible to configure only an IPv4 address.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ip-prefix

leaf: destination-network

description: The IP network to match the destination IP address. Currently, it is possible to configure only an IPv4 address.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ip-prefix

leaf: protocol

description: The IP protocol number.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)uint8

leaf: dscp

description: The IP DSCP field value.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)dscp

choice: vtn-layer4-match

description: The flow condition to match layer 4 protocol header.
min elements: 0
max elements: 2147483647

case: vtn-icmp-match

min elements: 0
max elements: 2147483647

uses: vtn-icmp-match-fields

refines:

leaf: icmp-type

description: The ICMP type.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)uint8

leaf: icmp-code

description: The ICMP code.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)uint8

case: vtn-tcp-match

min elements: 0
max elements: 2147483647

uses: vtn-tcp-match-fields

refines:

container: tcp-source-range

description: The range of TCP source port number.
min elements: 0
max elements: 2147483647

uses: vtn-port-range

refines:

leaf: port-from

description: The minimum value (inclusive) in the range of port numbers to match against packets.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

leaf: port-to

description: The maximum value (inclusive) in the range of port numbers to match against packets. The value must be greater than or equal to the value specified to `port-from' field. If this field is omitted, it will be treated as the port number specified to `port-from' field is specified.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

container: tcp-destination-range

description: The range of TCP destination port number.
min elements: 0
max elements: 2147483647

uses: vtn-port-range

refines:

leaf: port-from

description: The minimum value (inclusive) in the range of port numbers to match against packets.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

leaf: port-to

description: The maximum value (inclusive) in the range of port numbers to match against packets. The value must be greater than or equal to the value specified to `port-from' field. If this field is omitted, it will be treated as the port number specified to `port-from' field is specified.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

case: vtn-udp-match

min elements: 0
max elements: 2147483647

uses: vtn-udp-match-fields

refines:

container: udp-source-range

description: The range of UDP source port number.
min elements: 0
max elements: 2147483647

uses: vtn-port-range

refines:

leaf: port-from

description: The minimum value (inclusive) in the range of port numbers to match against packets.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

leaf: port-to

description: The maximum value (inclusive) in the range of port numbers to match against packets. The value must be greater than or equal to the value specified to `port-from' field. If this field is omitted, it will be treated as the port number specified to `port-from' field is specified.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

container: udp-destination-range

description: The range of UDP destination port number.
min elements: 0
max elements: 2147483647

uses: vtn-port-range

refines:

leaf: port-from

description: The minimum value (inclusive) in the range of port numbers to match against packets.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

leaf: port-to

description: The maximum value (inclusive) in the range of port numbers to match against packets. The value must be greater than or equal to the value specified to `port-from' field. If this field is omitted, it will be treated as the port number specified to `port-from' field is specified.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

leaf: operation

description: Describes how to update the specified flow condition if it already exists. If `SET' is specified, the given flow condition configuration will be applied as specified. In other words, existing flow condition configuration will be removed, and the given flow condition will be created. If `ADD' is specified, the given flow condition configuration will be merged with existing configuration. The target flow condition will be created if it is not present. Null will be treated as if `ADD' is specified. Note that the operation will fail if true is set to `present' field and the target flow condition is not present.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:vtn:types)vtn-update-operation-type

leaf: present

description: If true is set, the opration will fail unless the target flow condition is present. Null will be treated as if false is specified.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)boolean

container: output

min elements: 0
max elements: 2147483647

uses: (urn:opendaylight:vtn:types)vtn-rpc-result

refines:

leaf: status

description: Describes the status of the RPC result.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:vtn:types)vtn-update-type

clear-flow-condition

Description: Remove all the flow conditions. `status' in RPC output descripts the result of the operation. `REMOVED' indicates that at least one flow condition has been removed. Null indicates that no flow condition is present. On failure, one of vtn-error-tag value which indicates the cause of error is set into application tag in RPC error. `INTERNALERROR' is set if the operation failed due to internal error.

container: output

min elements: 0
max elements: 2147483647

uses: (urn:opendaylight:vtn:types)vtn-rpc-result

refines:

leaf: status

description: Describes the status of the RPC result.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:vtn:types)vtn-update-type

set-flow-condition-match

Description: Configure a flow match condition into the flow condition specified by the flow condition name and match index. This operation takes a list of `vtn-flow-match-config', and put all configurations in that list into the specified flow condition. Match indices specified in the RPC input will be copied to the RPC output, and `status' field in `vtn-flow-match-result' describes the result of the operation. `CREATED` indicates that the flow match configuration specified by the index value has been newly created. `CHANGED' indicates that the flow match configuration specified by the index value has been successfully changed. Null indicates that the flow match configuration specified by the index value 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 specified flow condition is not present. `INTERNALERROR' is set if the operation failed due to internal error.

container: input

min elements: 0
max elements: 2147483647

leaf: name

description: The name of the target flow condition.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)string

list: flow-match-list

description: A list of `vtn-flow-match-config' to be applied to the flow condition specified by `name' field. Note that a duplicate match index in this list will cause a `BADREQUEST' error.
min elements: 0
max elements: 2147483647

uses: vtn-flow-match-config

refines:

leaf: index

description: The index value that determines the order of elements in a list.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:vtn:types)int32

container: vtn-ether-match

description: The flow condition to match against Ethernet header.
min elements: 0
max elements: 2147483647

uses: vtn-ether-match-fields

refines:

leaf: source-address

description: The source MAC address.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address

leaf: destination-address

description: The destination MAC address.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address

leaf: ether-type

description: The ethernet type.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:l2:types)ether-type

leaf: vlan-id

description: The VLAN ID in VLAN tag. Zero means untagged ethernet frame.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:l2:types)vlan-id

leaf: vlan-pcp

description: The VLAN priority in VLAN tag.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:l2:types)vlan-pcp

container: vtn-inet-match

description: The flow condition to match against IP header.
min elements: 0
max elements: 2147483647

uses: vtn-inet-match-fields

refines:

leaf: source-network

description: The IP network to match the source IP address. Currently, it is possible to configure only an IPv4 address.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ip-prefix

leaf: destination-network

description: The IP network to match the destination IP address. Currently, it is possible to configure only an IPv4 address.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ip-prefix

leaf: protocol

description: The IP protocol number.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)uint8

leaf: dscp

description: The IP DSCP field value.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)dscp

choice: vtn-layer4-match

description: The flow condition to match layer 4 protocol header.
min elements: 0
max elements: 2147483647

case: vtn-icmp-match

min elements: 0
max elements: 2147483647

uses: vtn-icmp-match-fields

refines:

leaf: icmp-type

description: The ICMP type.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)uint8

leaf: icmp-code

description: The ICMP code.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)uint8

case: vtn-tcp-match

min elements: 0
max elements: 2147483647

uses: vtn-tcp-match-fields

refines:

container: tcp-source-range

description: The range of TCP source port number.
min elements: 0
max elements: 2147483647

uses: vtn-port-range

refines:

leaf: port-from

description: The minimum value (inclusive) in the range of port numbers to match against packets.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

leaf: port-to

description: The maximum value (inclusive) in the range of port numbers to match against packets. The value must be greater than or equal to the value specified to `port-from' field. If this field is omitted, it will be treated as the port number specified to `port-from' field is specified.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

container: tcp-destination-range

description: The range of TCP destination port number.
min elements: 0
max elements: 2147483647

uses: vtn-port-range

refines:

leaf: port-from

description: The minimum value (inclusive) in the range of port numbers to match against packets.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

leaf: port-to

description: The maximum value (inclusive) in the range of port numbers to match against packets. The value must be greater than or equal to the value specified to `port-from' field. If this field is omitted, it will be treated as the port number specified to `port-from' field is specified.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

case: vtn-udp-match

min elements: 0
max elements: 2147483647

uses: vtn-udp-match-fields

refines:

container: udp-source-range

description: The range of UDP source port number.
min elements: 0
max elements: 2147483647

uses: vtn-port-range

refines:

leaf: port-from

description: The minimum value (inclusive) in the range of port numbers to match against packets.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

leaf: port-to

description: The maximum value (inclusive) in the range of port numbers to match against packets. The value must be greater than or equal to the value specified to `port-from' field. If this field is omitted, it will be treated as the port number specified to `port-from' field is specified.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

container: udp-destination-range

description: The range of UDP destination port number.
min elements: 0
max elements: 2147483647

uses: vtn-port-range

refines:

leaf: port-from

description: The minimum value (inclusive) in the range of port numbers to match against packets.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

leaf: port-to

description: The maximum value (inclusive) in the range of port numbers to match against packets. The value must be greater than or equal to the value specified to `port-from' field. If this field is omitted, it will be treated as the port number specified to `port-from' field is specified.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number

container: output

min elements: 0
max elements: 2147483647

list: set-match-result

description: Describes pairs of match indices passed to the RPC input and results.
min elements: 0
max elements: 2147483647

uses: vtn-flow-match-result

refines:

leaf: index

description: The index value that specifies the flow match in the flow condition.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)int32

leaf: status

description: Describes the status of the RPC result.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:vtn:types)vtn-update-type

remove-flow-condition

Description: Remove the flow condition specified by the name. 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 flow condition is not present. `INTERNALERROR' is set if the operation failed due to internal error.

container: input

min elements: 0
max elements: 2147483647

leaf: name

description: The name of the flow condition to be removed.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)string

remove-flow-condition-match

Description: Remove the flow match condition specified by the flow condition name and match index. Values passed to `match-index' list will be copied to the RPC output, and `status' field in `vtn-flow-match-result' describes the result of the operation. `REMOVED' indicates that the flow match associated with the match index has been successfully removed. Null indicates that the flow match is not associated with the match index in the specified flow condition. 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 flow condition is not present. `INTERNALERROR' is set if the operation failed due to internal error.

container: input

min elements: 0
max elements: 2147483647

leaf: name

description: The name of the flow condition to be removed.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)string

leaf-list: match-index

description: A list of match indices to be removed from the flow condition specified by the `name' field. Duplicates in this list will be eliminated automatically.
min elements: 0
max elements: 2147483647
type: int32

container: output

min elements: 0
max elements: 2147483647

list: remove-match-result

description: Describes pairs of match indices passed to the RPC input and results.
min elements: 0
max elements: 2147483647

uses: vtn-flow-match-result

refines:

leaf: index

description: The index value that specifies the flow match in the flow condition.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)int32

leaf: status

description: Describes the status of the RPC result.
min elements: 0
max elements: 2147483647
type: (urn:opendaylight:vtn:types)vtn-update-type

vtn-flow-condition

Base Information

Groupings Summary

Child Nodes Summary

RPCs Summary

Groupings

vtn-icmp-match-fields

vtn-match-fields

vtn-ether-match-fields

vtn-flow-match-config

vtn-tcp-match-fields

vtn-port-range

vtn-udp-match-fields

vtn-inet-match-fields

vtn-flow-match-result

vtn-flow-cond-config

Datastore Structure

Child nodes

Direct children

vtn-flow-conditions

Direct children

XML example

vtn-flow-conditions/vtn-flow-condition

Direct children

XML example

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match

Direct children

XML example

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/vtn-ether-match

Direct children

XML example

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/vtn-inet-match

Direct children

XML example

XML example

Direct children

XML example

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/tcp-source-range

Direct children

XML example

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/tcp-destination-range

Direct children

XML example

Direct children

XML example

Direct children

XML example

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/udp-source-range

Direct children

XML example

vtn-flow-conditions/vtn-flow-condition/vtn-flow-match/udp-destination-range

Direct children

XML example

RPC Definitions

set-flow-condition

clear-flow-condition

set-flow-condition-match

remove-flow-condition

remove-flow-condition-match