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

Datastore Structure

vtn-flow-condition

Child nodes

Direct children

vtn-flow-conditions

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

Direct children

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

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

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

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

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

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

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

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

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

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

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

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

clear-flow-condition

set-flow-condition-match

remove-flow-condition

remove-flow-condition-match