vtn-flow

Base Information

Groupings Summary

RPCs Summary

Type Definitions

• vtn-flow-id

  • Description: Identifier for a VTN data flow.
  • Base type: (urn:opendaylight:flow:types)flow-cookie
  • Range restrictions:
  • <0, 18446744073709551615>

• virtual-route-reason

  • Description: Describes the reason why the packet is forwarded to the virtual node.
  • Base type: enumeration

• data-flow-mode

  • Description: Describes modes used to query information about data flow.
  • Base type: enumeration

Groupings

• vtn-data-flow-common

  • Description: Describes a common information about a data flow established by the VTN Manager.
  • leaf: flow-id
  • description: Identifier for a VTN data flow.
  • type: vtn-flow-id
  • leaf: creation-time
  • description: The creation time of the VTN data flow. This field keeps the number of milliseconds between the creation time and 1970-01-01T00:00:00+0000.
  • type: (urn:ietf:params:xml:ns:yang:1)int64
  • list: virtual-route
  • description: A sequence of `virtual-route-info' which represents the packet route in the virtual network. This list is omitted if the virtual packet route is not configured. Note that elements in this list needs to be sorted by `order' field in ascending order.
  • uses: (urn:opendaylight:action:types)ordered
  • refines:
  • uses: virtual-route-info
  • refines:
  • leaf: order
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • container: virtual-node-path
  • description: Describes the location of the virtual node inside the VTN. Note that this container is omitted if this model indicates that the data flow is terminated without packet forwarding.
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: bridge-name
  • description: The name of the vBridge. This field is omitted if the virtual node specified by this model is neither a vBridge nor a virtual node attached to the vBridge.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: router-name
  • description: The name of the vRouter. Currently the VTN Manager never uses this field because the virtual router is not yet supported.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: terminal-name
  • description: The name of the vTerminal. This field is ignored if `bridge-name' field is configured. This field is omitted if the virtual node specified by this model is neither a vTerminal nor a virtual node attached to the vTerminal.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: interface-name
  • description: The name of the virtual interface. - If the virtual interface specified by this model is attached to a vBridge, the name of the vBridge is set to `bridge-name' field. - If the virtual interface specified by this model is attached to a vTerminal, the name of the vTerminal is set to `terminal-name' field. - This field is omitted if the virtual node specified by this model is not a virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: reason
  • description: Describes the reason why the packet is forwarded to the virtual node. Note that this field is omitted if this model indicates that the data flow is terminated without packet forwarding.
  • type: virtual-route-reason

• averaged-flow-stats-fields

  • Description: Describes the averaged flow statistics per second.
  • leaf: packet-count
  • description: The averaged number of packets per second forwarded by the flow entry.
  • type: decimal64
  • leaf: byte-count
  • description: The averaged number of bytes in packets per second forwarded by the flow entry.
  • type: decimal64
  • leaf: start-time
  • description: The system time when the measurement period begins. The value in this field represents the number of milliseconds between the start time and 1970-01-01T00:00:00+0000.
  • type: (urn:ietf:params:xml:ns:yang:1)int64
  • leaf: end-time
  • description: The system time when the measurement period ends. The value in this field represents the number of milliseconds between the end time and 1970-01-01T00:00:00+0000.
  • type: (urn:ietf:params:xml:ns:yang:1)int64

• vtn-flow-identifiable

  • Description: Describes an interface that specifies a VTN data flow.
  • leaf: flow-id
  • description: Identifier for a VTN data flow.
  • type: vtn-flow-id

• vtn-data-flow-info

  • Description: Describes a data flow established by the VTN Manager.
  • leaf: creation-time
  • description: The creation time of the VTN data flow. This field keeps the number of milliseconds between the creation time and 1970-01-01T00:00:00+0000.
  • type: (urn:ietf:params:xml:ns:yang:1)int64
  • list: virtual-route
  • description: A sequence of `virtual-route-info' which represents the packet route in the virtual network. This list is omitted if the virtual packet route is not configured. Note that elements in this list needs to be sorted by `order' field in ascending order.
  • uses: (urn:opendaylight:action:types)ordered
  • refines:
  • uses: virtual-route-info
  • refines:
  • leaf: order
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • container: virtual-node-path
  • description: Describes the location of the virtual node inside the VTN. Note that this container is omitted if this model indicates that the data flow is terminated without packet forwarding.
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: bridge-name
  • description: The name of the vBridge. This field is omitted if the virtual node specified by this model is neither a vBridge nor a virtual node attached to the vBridge.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: router-name
  • description: The name of the vRouter. Currently the VTN Manager never uses this field because the virtual router is not yet supported.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: terminal-name
  • description: The name of the vTerminal. This field is ignored if `bridge-name' field is configured. This field is omitted if the virtual node specified by this model is neither a vTerminal nor a virtual node attached to the vTerminal.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: interface-name
  • description: The name of the virtual interface. - If the virtual interface specified by this model is attached to a vBridge, the name of the vBridge is set to `bridge-name' field. - If the virtual interface specified by this model is attached to a vTerminal, the name of the vTerminal is set to `terminal-name' field. - This field is omitted if the virtual node specified by this model is not a virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: reason
  • description: Describes the reason why the packet is forwarded to the virtual node. Note that this field is omitted if this model indicates that the data flow is terminated without packet forwarding.
  • type: virtual-route-reason
  • leaf: flow-id
  • description: Identifier for a VTN data flow.
  • type: vtn-flow-id
  • leaf: idle-timeout
  • description: The number of seconds to be set to `idle-timeout' field in flow entries. Zero means an infinite time.
  • type: (urn:ietf:params:xml:ns:yang:1)uint16
  • leaf: hard-timeout
  • description: The number of seconds to be set to `hard-timeout' field in flow entries. Zero means an infinite time.
  • type: (urn:ietf:params:xml:ns:yang:1)uint16
  • container: data-ingress-node
  • description: The location of the virtual node which maps the incoming packet.
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: bridge-name
  • description: The name of the vBridge. This field is omitted if the virtual node specified by this model is neither a vBridge nor a virtual node attached to the vBridge.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: router-name
  • description: The name of the vRouter. Currently the VTN Manager never uses this field because the virtual router is not yet supported.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: terminal-name
  • description: The name of the vTerminal. This field is ignored if `bridge-name' field is configured. This field is omitted if the virtual node specified by this model is neither a vTerminal nor a virtual node attached to the vTerminal.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: interface-name
  • description: The name of the virtual interface. - If the virtual interface specified by this model is attached to a vBridge, the name of the vBridge is set to `bridge-name' field. - If the virtual interface specified by this model is attached to a vTerminal, the name of the vTerminal is set to `terminal-name' field. - This field is omitted if the virtual node specified by this model is not a virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • container: data-ingress-port
  • description: The location of the physical switch port where the incoming packet is received.
  • uses: (urn:opendaylight:vtn:types)vtn-port-location
  • refines:
  • leaf: node
  • description: Identifier for a physical switch.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: port-id
  • description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: port-name
  • description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
  • type: (urn:opendaylight:vtn:types)string
  • container: data-egress-node
  • description: The location of the virtual node which sends the outgoing packet to the physical network. Note that this container is omitted if this data flow discards the packet.
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: bridge-name
  • description: The name of the vBridge. This field is omitted if the virtual node specified by this model is neither a vBridge nor a virtual node attached to the vBridge.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: router-name
  • description: The name of the vRouter. Currently the VTN Manager never uses this field because the virtual router is not yet supported.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: terminal-name
  • description: The name of the vTerminal. This field is ignored if `bridge-name' field is configured. This field is omitted if the virtual node specified by this model is neither a vTerminal nor a virtual node attached to the vTerminal.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: interface-name
  • description: The name of the virtual interface. - If the virtual interface specified by this model is attached to a vBridge, the name of the vBridge is set to `bridge-name' field. - If the virtual interface specified by this model is attached to a vTerminal, the name of the vTerminal is set to `terminal-name' field. - This field is omitted if the virtual node specified by this model is not a virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • container: data-egress-port
  • description: The location of the physical switch port to which the outgoing packet is sent. Note that this container is omitted if this data flow discards the packet.
  • uses: (urn:opendaylight:vtn:types)vtn-port-location
  • refines:
  • leaf: node
  • description: Identifier for a physical switch.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: port-id
  • description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: port-name
  • description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
  • type: (urn:opendaylight:vtn:types)string
  • container: data-flow-match
  • description: The flow condition configured in the ingress flow entry. This container is omitted if the flow condition is not configured.
  • uses: (urn:opendaylight:vtn:flow:cond)vtn-match-fields
  • refines:
  • container: vtn-ether-match
  • description: The flow condition to match against Ethernet header.
  • uses: (urn:opendaylight:vtn:flow:cond)vtn-ether-match-fields
  • refines:
  • leaf: source-address
  • description: The source MAC address.
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • leaf: destination-address
  • description: The destination MAC address.
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • leaf: ether-type
  • description: The ethernet type.
  • type: (urn:opendaylight:l2:types)ether-type
  • leaf: vlan-id
  • description: The VLAN ID in VLAN tag. Zero means untagged ethernet frame.
  • type: (urn:opendaylight:l2:types)vlan-id
  • leaf: vlan-pcp
  • description: The VLAN priority in VLAN tag.
  • type: (urn:opendaylight:l2:types)vlan-pcp
  • container: vtn-inet-match
  • description: The flow condition to match against IP header.
  • uses: (urn:opendaylight:vtn:flow:cond)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.
  • 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.
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ip-prefix
  • leaf: protocol
  • description: The IP protocol number.
  • type: (urn:ietf:params:xml:ns:yang:1)uint8
  • leaf: dscp
  • description: The IP DSCP field value.
  • 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.
  • case: vtn-icmp-match
  • uses: (urn:opendaylight:vtn:flow:cond)vtn-icmp-match-fields
  • refines:
  • leaf: icmp-type
  • description: The ICMP type.
  • type: (urn:ietf:params:xml:ns:yang:1)uint8
  • leaf: icmp-code
  • description: The ICMP code.
  • type: (urn:ietf:params:xml:ns:yang:1)uint8
  • case: vtn-tcp-match
  • uses: (urn:opendaylight:vtn:flow:cond)vtn-tcp-match-fields
  • refines:
  • container: tcp-source-range
  • description: The range of TCP source port number.
  • uses: (urn:opendaylight:vtn:flow:cond)vtn-port-range
  • refines:
  • leaf: port-from
  • description: The minimum value (inclusive) in the range of port numbers to match against packets.
  • 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.
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number
  • container: tcp-destination-range
  • description: The range of TCP destination port number.
  • uses: (urn:opendaylight:vtn:flow:cond)vtn-port-range
  • refines:
  • leaf: port-from
  • description: The minimum value (inclusive) in the range of port numbers to match against packets.
  • 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.
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number
  • case: vtn-udp-match
  • uses: (urn:opendaylight:vtn:flow:cond)vtn-udp-match-fields
  • refines:
  • container: udp-source-range
  • description: The range of UDP source port number.
  • uses: (urn:opendaylight:vtn:flow:cond)vtn-port-range
  • refines:
  • leaf: port-from
  • description: The minimum value (inclusive) in the range of port numbers to match against packets.
  • 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.
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number
  • container: udp-destination-range
  • description: The range of UDP destination port number.
  • uses: (urn:opendaylight:vtn:flow:cond)vtn-port-range
  • refines:
  • leaf: port-from
  • description: The minimum value (inclusive) in the range of port numbers to match against packets.
  • 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.
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number
  • list: vtn-flow-action
  • description: Describes a list of flow actions supported by the VTN Manager. Each action in this list needs to have a unique index value in `order' field. Flow actions in a flow entry are sorted by `order' field in ascending order.
  • key definition: order
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ordered-flow-action
  • refines:
  • leaf: order
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • choice: vtn-action
  • description: Describes the abstract type of flow action.
  • case: vtn-drop-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-drop-action'.
  • container: vtn-drop-action
  • description: Describes the flow action that drops every packet.
  • case: vtn-pop-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-pop-vlan-action'.
  • container: vtn-pop-vlan-action
  • description: Describes the flow action that strips the outermost VLAN tag.
  • case: vtn-push-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-push-vlan-action'.
  • container: vtn-push-vlan-action
  • description: Describes the flow action that adds a VLAN tag into packet.
  • leaf: vlan-type
  • description: Describes the type for a new VLAN tag.
  • type: (urn:opendaylight:vtn:types)vlan-type
  • case: vtn-set-dl-dst-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-dl-dst-action'.
  • container: vtn-set-dl-dst-action
  • description: Describes the flow action that sets the specified destination MAC address into the Ethernet header. Node that the following MAC address cannot be specified. - Broadcast address - Multicast address - Zero
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • case: vtn-set-dl-src-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-dl-src-action'.
  • container: vtn-set-dl-src-action
  • description: Describes the flow action that sets the specified source MAC address into the Ethernet header. Node that the following MAC address cannot be specified. - Broadcast address - Multicast address - Zero
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • case: vtn-set-icmp-code-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-icmp-code-action'.
  • container: vtn-set-icmp-code-action
  • description: Describes the flow action that sets the specified ICMP code into the ICMP header. Currently, this action only affects ICMP packet on IPv4.
  • leaf: code
  • description: The ICMP code to be set. If this field is omitted, it will be treated as zero is specified.
  • type: code
  • default: 0
  • case: vtn-set-icmp-type-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-icmp-type-action'.
  • container: vtn-set-icmp-type-action
  • description: Describes the flow action that sets the specified ICMP type into the ICMP header. Currently, this action only affects ICMP packet on IPv4.
  • leaf: type
  • description: The ICMP type to be set. If this field is omitted, it will be treated as zero is specified.
  • type: type
  • default: 0
  • case: vtn-set-inet-dscp-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-inet-dscp-action'.
  • container: vtn-set-inet-dscp-action
  • description: Describes the flow action that sets the specified IP DSCP value into the IP header. Currently, only IPv4 packet can be modified by this action.
  • leaf: dscp
  • description: The DSCP value to be set. If this field is omitted, it will be treated as zero is specified.
  • type: dscp
  • default: 0
  • case: vtn-set-inet-dst-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-inet-dst-action'.
  • container: vtn-set-inet-dst-action
  • description: Describes the flow action that sets the specified destination IP address into the IP header. Currently, only IPv4 address can be specified and this action affects only IPv4 packet.
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • case: ipv4
  • leaf: ipv4-address
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • leaf: ipv6-address
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv6-prefix
  • case: vtn-set-inet-src-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-inet-src-action'.
  • container: vtn-set-inet-src-action
  • description: Describes the flow action that sets the specified source IP address into the IP header. Currently, only IPv4 address can be specified and this action affects only IPv4 packet.
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • case: ipv4
  • leaf: ipv4-address
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • leaf: ipv6-address
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv6-prefix
  • case: vtn-set-port-dst-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-port-dst-action'.
  • container: vtn-set-port-dst-action
  • description: Describes the flow action that sets the specified destination port number into the TCP or UDP header. Currently, this action only affects TCP or UDP packet on IPv4.
  • uses: (urn:opendaylight:vtn:flow:action)vtn-port-action-fields
  • refines:
  • leaf: port
  • description: Describes the port number to be set. If this field is omitted, it will be treated as zero is specified.
  • type: port
  • default: 0
  • case: vtn-set-port-src-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-port-src-action'.
  • container: vtn-set-port-src-action
  • description: Describes the flow action that sets the specified source port number into the TCP or UDP header. Currently, this action only affects TCP or UDP packet on IPv4.
  • uses: (urn:opendaylight:vtn:flow:action)vtn-port-action-fields
  • refines:
  • leaf: port
  • description: Describes the port number to be set. If this field is omitted, it will be treated as zero is specified.
  • type: port
  • default: 0
  • case: vtn-set-vlan-id-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-vlan-id-action'.
  • container: vtn-set-vlan-id-action
  • description: Describes the flow action that sets the specified VLAN ID into the IEEE 802.1Q VLAN tag.
  • leaf: vlan-id
  • description: The VLAN ID to be set. Note that zero cannot be specified. If you need a flow action which removes VLAN tag from packets, use `vtn-pop-vlan-action' instead.
  • type: (urn:opendaylight:vtn:flow:action)uint16
  • case: vtn-set-vlan-pcp-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-set-vlan-pcp-action'.
  • container: vtn-set-vlan-pcp-action
  • description: Describes the flow action that sets the specified VLAN priority into the IEEE 802.1Q VLAN tag.
  • leaf: vlan-pcp
  • description: The VLAN priority to be set. If this field is omitted, it will be treated as zero is specified.
  • type: vlan-pcp
  • default: 0
  • list: physical-route
  • description: A sequence of `physical-route-info' which represents the packet route in the physical network. This list is omitted if this data flow discards the packet, or if the physical packet route is not configured. Note that elements in this list needs to be sorted by `order' field in ascending order.
  • uses: (urn:opendaylight:action:types)ordered
  • refines:
  • uses: physical-route-info
  • refines:
  • leaf: order
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • leaf: node
  • description: Identifier for a physical switch.
  • type: (urn:opendaylight:inventory)node-id
  • container: physical-ingress-port
  • description: Identifier for the switch port where the packet is received.
  • uses: (urn:opendaylight:vtn:types)vtn-switch-port
  • refines:
  • leaf: port-id
  • description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: port-name
  • description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
  • type: (urn:opendaylight:vtn:types)string
  • container: physical-egress-port
  • description: Identifier for the switch port to which the packet is sent.
  • uses: (urn:opendaylight:vtn:types)vtn-switch-port
  • refines:
  • leaf: port-id
  • description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: port-name
  • description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
  • type: (urn:opendaylight:vtn:types)string
  • container: data-flow-stats
  • description: Statistics information about this data flow. This container is omitted if statistics information is unavailable, or it is not configured.
  • uses: (urn:opendaylight:model:statistics:types)generic-statistics
  • refines:
  • leaf: packet-count
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)counter64
  • leaf: byte-count
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)counter64
  • container: duration
  • leaf: second
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)counter32
  • leaf: nanosecond
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)counter32
  • container: averaged-data-flow-stats
  • description: Statistics information per second about this data flow. This container is omitted if statistics information is unavailable, or it is not configured.
  • uses: averaged-flow-stats-fields
  • refines:
  • leaf: packet-count
  • description: The averaged number of packets per second forwarded by the flow entry.
  • type: decimal64
  • leaf: byte-count
  • description: The averaged number of bytes in packets per second forwarded by the flow entry.
  • type: decimal64
  • leaf: start-time
  • description: The system time when the measurement period begins. The value in this field represents the number of milliseconds between the start time and 1970-01-01T00:00:00+0000.
  • type: (urn:ietf:params:xml:ns:yang:1)int64
  • leaf: end-time
  • description: The system time when the measurement period ends. The value in this field represents the number of milliseconds between the end time and 1970-01-01T00:00:00+0000.
  • type: (urn:ietf:params:xml:ns:yang:1)int64

• physical-route-info

  • Description: 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.
  • leaf: node
  • description: Identifier for a physical switch.
  • type: (urn:opendaylight:inventory)node-id
  • container: physical-ingress-port
  • description: Identifier for the switch port where the packet is received.
  • uses: (urn:opendaylight:vtn:types)vtn-switch-port
  • refines:
  • leaf: port-id
  • description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: port-name
  • description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
  • type: (urn:opendaylight:vtn:types)string
  • container: physical-egress-port
  • description: Identifier for the switch port to which the packet is sent.
  • uses: (urn:opendaylight:vtn:types)vtn-switch-port
  • refines:
  • leaf: port-id
  • description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: port-name
  • description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
  • type: (urn:opendaylight:vtn:types)string

• virtual-route-info

  • Description: 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.
  • container: virtual-node-path
  • description: Describes the location of the virtual node inside the VTN. Note that this container is omitted if this model indicates that the data flow is terminated without packet forwarding.
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: bridge-name
  • description: The name of the vBridge. This field is omitted if the virtual node specified by this model is neither a vBridge nor a virtual node attached to the vBridge.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: router-name
  • description: The name of the vRouter. Currently the VTN Manager never uses this field because the virtual router is not yet supported.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: terminal-name
  • description: The name of the vTerminal. This field is ignored if `bridge-name' field is configured. This field is omitted if the virtual node specified by this model is neither a vTerminal nor a virtual node attached to the vTerminal.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: interface-name
  • description: The name of the virtual interface. - If the virtual interface specified by this model is attached to a vBridge, the name of the vBridge is set to `bridge-name' field. - If the virtual interface specified by this model is attached to a vTerminal, the name of the vTerminal is set to `terminal-name' field. - This field is omitted if the virtual node specified by this model is not a virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: reason
  • description: Describes the reason why the packet is forwarded to the virtual node. Note that this field is omitted if this model indicates that the data flow is terminated without packet forwarding.
  • type: virtual-route-reason

RPC Definitions

get-data-flow

• Description: 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.
• container: input
• uses: vtn-flow-identifiable
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: flow-id
• description: Identifier for a VTN data flow.
• type: vtn-flow-id
• leaf: mode
• description: Specifies behavior of this operation. If omitted, it is treated as if SUMMARY is specified.
• type: mode
• default: SUMMARY
• leaf: node
• description: Identifier for a physical switch. If this field is specified and `data-flow-port' field is omitted, only data flows that forward packets via the specified switch will be selected.
• type: (urn:opendaylight:inventory)node-id
• container: data-flow-port
• description: Specifies the location of the physical switch port in the physical switch specified by `node' field. If both this field and `node' field are specified, only data flows that forward packets via the specified switch port will be selected. This field will be ignored if `node' field is omitted.
• uses: (urn:opendaylight:vtn:types)vtn-switch-port
• refines:
• leaf: port-id
• description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: port-name
• description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
• type: (urn:opendaylight:vtn:types)string
• container: data-flow-source
• description: Specifies the L2 source host of the data flow. If this field is specified, only data flows that map packets sent by the specified L2 host will be selected.
• uses: (urn:opendaylight:vtn:types)vlan-host
• refines:
• leaf: mac-address
• description: MAC address of the host.
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
• leaf: vlan-id
• description: Specifies the VLAN ID. Zero implies untagged Ethernet frame. If omitted, it will be treated as zero is specified.
• type: (urn:opendaylight:l2:types)vlan-id
• leaf: average-interval
• description: The number of seconds in the measurement period for averaged flow statistics. `averaged-flow-stats' field is omitted if no valid flow statistics are logged within the given interval. Specifying zero or a negative value is treated as if 10 is specified. Note that this value is just a hint for determining the measurement period. The actual measurement period can be derived from `averaged-flow-stats' field. This field is ignored if SUMMARY is specified in `mode'.
• type: average-interval
• default: 10
• container: output
• list: data-flow-info
• description: A list of information about data flows that meets the condition specified by the RPC input.
• uses: vtn-data-flow-info
• refines:
• container: data-ingress-node
• description: The location of the virtual node which maps the incoming packet.
• uses: (urn:opendaylight:vtn:types)vnode-path-fields
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: bridge-name
• description: The name of the vBridge. This field is omitted if the virtual node specified by this model is neither a vBridge nor a virtual node attached to the vBridge.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: router-name
• description: The name of the vRouter. Currently the VTN Manager never uses this field because the virtual router is not yet supported.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: terminal-name
• description: The name of the vTerminal. This field is ignored if `bridge-name' field is configured. This field is omitted if the virtual node specified by this model is neither a vTerminal nor a virtual node attached to the vTerminal.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: interface-name
• description: The name of the virtual interface. - If the virtual interface specified by this model is attached to a vBridge, the name of the vBridge is set to `bridge-name' field. - If the virtual interface specified by this model is attached to a vTerminal, the name of the vTerminal is set to `terminal-name' field. - This field is omitted if the virtual node specified by this model is not a virtual interface.
• type: (urn:ietf:params:xml:ns:yang:1)string
• container: data-ingress-port
• description: The location of the physical switch port where the incoming packet is received.
• uses: (urn:opendaylight:vtn:types)vtn-port-location
• refines:
• leaf: node
• description: Identifier for a physical switch.
• type: (urn:opendaylight:inventory)node-id
• leaf: port-id
• description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: port-name
• description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
• type: (urn:opendaylight:vtn:types)string
• container: data-egress-node
• description: The location of the virtual node which sends the outgoing packet to the physical network. Note that this container is omitted if this data flow discards the packet.
• uses: (urn:opendaylight:vtn:types)vnode-path-fields
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: bridge-name
• description: The name of the vBridge. This field is omitted if the virtual node specified by this model is neither a vBridge nor a virtual node attached to the vBridge.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: router-name
• description: The name of the vRouter. Currently the VTN Manager never uses this field because the virtual router is not yet supported.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: terminal-name
• description: The name of the vTerminal. This field is ignored if `bridge-name' field is configured. This field is omitted if the virtual node specified by this model is neither a vTerminal nor a virtual node attached to the vTerminal.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: interface-name
• description: The name of the virtual interface. - If the virtual interface specified by this model is attached to a vBridge, the name of the vBridge is set to `bridge-name' field. - If the virtual interface specified by this model is attached to a vTerminal, the name of the vTerminal is set to `terminal-name' field. - This field is omitted if the virtual node specified by this model is not a virtual interface.
• type: (urn:ietf:params:xml:ns:yang:1)string
• container: data-egress-port
• description: The location of the physical switch port to which the outgoing packet is sent. Note that this container is omitted if this data flow discards the packet.
• uses: (urn:opendaylight:vtn:types)vtn-port-location
• refines:
• leaf: node
• description: Identifier for a physical switch.
• type: (urn:opendaylight:inventory)node-id
• leaf: port-id
• description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: port-name
• description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
• type: (urn:opendaylight:vtn:types)string
• container: data-flow-match
• description: The flow condition configured in the ingress flow entry. This container is omitted if the flow condition is not configured.
• uses: (urn:opendaylight:vtn:flow:cond)vtn-match-fields
• refines:
• container: vtn-ether-match
• description: The flow condition to match against Ethernet header.
• uses: (urn:opendaylight:vtn:flow:cond)vtn-ether-match-fields
• refines:
• leaf: source-address
• description: The source MAC address.
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
• leaf: destination-address
• description: The destination MAC address.
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
• leaf: ether-type
• description: The ethernet type.
• type: (urn:opendaylight:l2:types)ether-type
• leaf: vlan-id
• description: The VLAN ID in VLAN tag. Zero means untagged ethernet frame.
• type: (urn:opendaylight:l2:types)vlan-id
• leaf: vlan-pcp
• description: The VLAN priority in VLAN tag.
• type: (urn:opendaylight:l2:types)vlan-pcp
• container: vtn-inet-match
• description: The flow condition to match against IP header.
• uses: (urn:opendaylight:vtn:flow:cond)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.
• 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.
• type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ip-prefix
• leaf: protocol
• description: The IP protocol number.
• type: (urn:ietf:params:xml:ns:yang:1)uint8
• leaf: dscp
• description: The IP DSCP field value.
• 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.
• case: vtn-icmp-match
• uses: (urn:opendaylight:vtn:flow:cond)vtn-icmp-match-fields
• refines:
• leaf: icmp-type
• description: The ICMP type.
• type: (urn:ietf:params:xml:ns:yang:1)uint8
• leaf: icmp-code
• description: The ICMP code.
• type: (urn:ietf:params:xml:ns:yang:1)uint8
• case: vtn-tcp-match
• uses: (urn:opendaylight:vtn:flow:cond)vtn-tcp-match-fields
• refines:
• container: tcp-source-range
• description: The range of TCP source port number.
• uses: (urn:opendaylight:vtn:flow:cond)vtn-port-range
• refines:
• leaf: port-from
• description: The minimum value (inclusive) in the range of port numbers to match against packets.
• 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.
• type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number
• container: tcp-destination-range
• description: The range of TCP destination port number.
• uses: (urn:opendaylight:vtn:flow:cond)vtn-port-range
• refines:
• leaf: port-from
• description: The minimum value (inclusive) in the range of port numbers to match against packets.
• 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.
• type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number
• case: vtn-udp-match
• uses: (urn:opendaylight:vtn:flow:cond)vtn-udp-match-fields
• refines:
• container: udp-source-range
• description: The range of UDP source port number.
• uses: (urn:opendaylight:vtn:flow:cond)vtn-port-range
• refines:
• leaf: port-from
• description: The minimum value (inclusive) in the range of port numbers to match against packets.
• 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.
• type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number
• container: udp-destination-range
• description: The range of UDP destination port number.
• uses: (urn:opendaylight:vtn:flow:cond)vtn-port-range
• refines:
• leaf: port-from
• description: The minimum value (inclusive) in the range of port numbers to match against packets.
• 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.
• type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)port-number
• list: physical-route
• description: A sequence of `physical-route-info' which represents the packet route in the physical network. This list is omitted if this data flow discards the packet, or if the physical packet route is not configured. Note that elements in this list needs to be sorted by `order' field in ascending order.
• uses: (urn:opendaylight:action:types)ordered
• refines:
• uses: physical-route-info
• refines:
• leaf: order
• type: (urn:ietf:params:xml:ns:yang:1)int32
• leaf: node
• description: Identifier for a physical switch.
• type: (urn:opendaylight:inventory)node-id
• container: physical-ingress-port
• description: Identifier for the switch port where the packet is received.
• uses: (urn:opendaylight:vtn:types)vtn-switch-port
• refines:
• leaf: port-id
• description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: port-name
• description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
• type: (urn:opendaylight:vtn:types)string
• container: physical-egress-port
• description: Identifier for the switch port to which the packet is sent.
• uses: (urn:opendaylight:vtn:types)vtn-switch-port
• refines:
• leaf: port-id
• description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: port-name
• description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
• type: (urn:opendaylight:vtn:types)string
• container: data-flow-stats
• description: Statistics information about this data flow. This container is omitted if statistics information is unavailable, or it is not configured.
• uses: (urn:opendaylight:model:statistics:types)generic-statistics
• refines:
• leaf: packet-count
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)counter64
• leaf: byte-count
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)counter64
• container: duration
• leaf: second
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)counter32
• leaf: nanosecond
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)counter32
• container: averaged-data-flow-stats
• description: Statistics information per second about this data flow. This container is omitted if statistics information is unavailable, or it is not configured.
• uses: averaged-flow-stats-fields
• refines:
• leaf: packet-count
• description: The averaged number of packets per second forwarded by the flow entry.
• type: decimal64
• leaf: byte-count
• description: The averaged number of bytes in packets per second forwarded by the flow entry.
• type: decimal64
• leaf: start-time
• description: The system time when the measurement period begins. The value in this field represents the number of milliseconds between the start time and 1970-01-01T00:00:00+0000.
• type: (urn:ietf:params:xml:ns:yang:1)int64
• leaf: end-time
• description: The system time when the measurement period ends. The value in this field represents the number of milliseconds between the end time and 1970-01-01T00:00:00+0000.
• type: (urn:ietf:params:xml:ns:yang:1)int64
• leaf: idle-timeout
• description: The number of seconds to be set to `idle-timeout' field in flow entries. Zero means an infinite time.
• type: (urn:ietf:params:xml:ns:yang:1)uint16
• leaf: hard-timeout
• description: The number of seconds to be set to `hard-timeout' field in flow entries. Zero means an infinite time.
• type: (urn:ietf:params:xml:ns:yang:1)uint16
• leaf: creation-time
• description: The creation time of the VTN data flow. This field keeps the number of milliseconds between the creation time and 1970-01-01T00:00:00+0000.
• type: (urn:ietf:params:xml:ns:yang:1)int64
• list: virtual-route
• description: A sequence of `virtual-route-info' which represents the packet route in the virtual network. This list is omitted if the virtual packet route is not configured. Note that elements in this list needs to be sorted by `order' field in ascending order.
• uses: (urn:opendaylight:action:types)ordered
• refines:
• uses: virtual-route-info
• refines:
• leaf: order
• type: (urn:ietf:params:xml:ns:yang:1)int32
• container: virtual-node-path
• description: Describes the location of the virtual node inside the VTN. Note that this container is omitted if this model indicates that the data flow is terminated without packet forwarding.
• uses: (urn:opendaylight:vtn:types)vnode-path-fields
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: bridge-name
• description: The name of the vBridge. This field is omitted if the virtual node specified by this model is neither a vBridge nor a virtual node attached to the vBridge.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: router-name
• description: The name of the vRouter. Currently the VTN Manager never uses this field because the virtual router is not yet supported.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: terminal-name
• description: The name of the vTerminal. This field is ignored if `bridge-name' field is configured. This field is omitted if the virtual node specified by this model is neither a vTerminal nor a virtual node attached to the vTerminal.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: interface-name
• description: The name of the virtual interface. - If the virtual interface specified by this model is attached to a vBridge, the name of the vBridge is set to `bridge-name' field. - If the virtual interface specified by this model is attached to a vTerminal, the name of the vTerminal is set to `terminal-name' field. - This field is omitted if the virtual node specified by this model is not a virtual interface.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: reason
• description: Describes the reason why the packet is forwarded to the virtual node. Note that this field is omitted if this model indicates that the data flow is terminated without packet forwarding.
• type: virtual-route-reason
• leaf: flow-id
• description: Identifier for a VTN data flow.
• type: vtn-flow-id
• list: vtn-flow-action
• description: Describes a list of flow actions supported by the VTN Manager. Each action in this list needs to have a unique index value in `order' field. Flow actions in a flow entry are sorted by `order' field in ascending order.
• key definition: order
• uses: (urn:opendaylight:vtn:flow:action)vtn-ordered-flow-action
• refines:
• leaf: order
• type: (urn:ietf:params:xml:ns:yang:1)int32
• choice: vtn-action
• description: Describes the abstract type of flow action.
• case: vtn-drop-action-case
• description: The branch of the `vtn-action' choice for the `vtn-drop-action'.
• container: vtn-drop-action
• description: Describes the flow action that drops every packet.
• case: vtn-pop-vlan-action-case
• description: The branch of the `vtn-action' choice for the `vtn-pop-vlan-action'.
• container: vtn-pop-vlan-action
• description: Describes the flow action that strips the outermost VLAN tag.
• case: vtn-push-vlan-action-case
• description: The branch of the `vtn-action' choice for the `vtn-push-vlan-action'.
• container: vtn-push-vlan-action
• description: Describes the flow action that adds a VLAN tag into packet.
• leaf: vlan-type
• description: Describes the type for a new VLAN tag.
• type: (urn:opendaylight:vtn:types)vlan-type
• case: vtn-set-dl-dst-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-dl-dst-action'.
• container: vtn-set-dl-dst-action
• description: Describes the flow action that sets the specified destination MAC address into the Ethernet header. Node that the following MAC address cannot be specified. - Broadcast address - Multicast address - Zero
• uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
• refines:
• leaf: address
• description: Describes the MAC address to be set into packet.
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
• case: vtn-set-dl-src-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-dl-src-action'.
• container: vtn-set-dl-src-action
• description: Describes the flow action that sets the specified source MAC address into the Ethernet header. Node that the following MAC address cannot be specified. - Broadcast address - Multicast address - Zero
• uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
• refines:
• leaf: address
• description: Describes the MAC address to be set into packet.
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
• case: vtn-set-icmp-code-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-icmp-code-action'.
• container: vtn-set-icmp-code-action
• description: Describes the flow action that sets the specified ICMP code into the ICMP header. Currently, this action only affects ICMP packet on IPv4.
• leaf: code
• description: The ICMP code to be set. If this field is omitted, it will be treated as zero is specified.
• type: code
• default: 0
• case: vtn-set-icmp-type-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-icmp-type-action'.
• container: vtn-set-icmp-type-action
• description: Describes the flow action that sets the specified ICMP type into the ICMP header. Currently, this action only affects ICMP packet on IPv4.
• leaf: type
• description: The ICMP type to be set. If this field is omitted, it will be treated as zero is specified.
• type: type
• default: 0
• case: vtn-set-inet-dscp-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-inet-dscp-action'.
• container: vtn-set-inet-dscp-action
• description: Describes the flow action that sets the specified IP DSCP value into the IP header. Currently, only IPv4 packet can be modified by this action.
• leaf: dscp
• description: The DSCP value to be set. If this field is omitted, it will be treated as zero is specified.
• type: dscp
• default: 0
• case: vtn-set-inet-dst-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-inet-dst-action'.
• container: vtn-set-inet-dst-action
• description: Describes the flow action that sets the specified destination IP address into the IP header. Currently, only IPv4 address can be specified and this action affects only IPv4 packet.
• uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
• refines:
• choice: address
• case: ipv4
• leaf: ipv4-address
• type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
• case: ipv6
• leaf: ipv6-address
• type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv6-prefix
• case: vtn-set-inet-src-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-inet-src-action'.
• container: vtn-set-inet-src-action
• description: Describes the flow action that sets the specified source IP address into the IP header. Currently, only IPv4 address can be specified and this action affects only IPv4 packet.
• uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
• refines:
• choice: address
• case: ipv4
• leaf: ipv4-address
• type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
• case: ipv6
• leaf: ipv6-address
• type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv6-prefix
• case: vtn-set-port-dst-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-port-dst-action'.
• container: vtn-set-port-dst-action
• description: Describes the flow action that sets the specified destination port number into the TCP or UDP header. Currently, this action only affects TCP or UDP packet on IPv4.
• uses: (urn:opendaylight:vtn:flow:action)vtn-port-action-fields
• refines:
• leaf: port
• description: Describes the port number to be set. If this field is omitted, it will be treated as zero is specified.
• type: port
• default: 0
• case: vtn-set-port-src-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-port-src-action'.
• container: vtn-set-port-src-action
• description: Describes the flow action that sets the specified source port number into the TCP or UDP header. Currently, this action only affects TCP or UDP packet on IPv4.
• uses: (urn:opendaylight:vtn:flow:action)vtn-port-action-fields
• refines:
• leaf: port
• description: Describes the port number to be set. If this field is omitted, it will be treated as zero is specified.
• type: port
• default: 0
• case: vtn-set-vlan-id-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-vlan-id-action'.
• container: vtn-set-vlan-id-action
• description: Describes the flow action that sets the specified VLAN ID into the IEEE 802.1Q VLAN tag.
• leaf: vlan-id
• description: The VLAN ID to be set. Note that zero cannot be specified. If you need a flow action which removes VLAN tag from packets, use `vtn-pop-vlan-action' instead.
• type: (urn:opendaylight:vtn:flow:action)uint16
• case: vtn-set-vlan-pcp-action-case
• description: The branch of the `vtn-action' choice for the `vtn-set-vlan-pcp-action'.
• container: vtn-set-vlan-pcp-action
• description: Describes the flow action that sets the specified VLAN priority into the IEEE 802.1Q VLAN tag.
• leaf: vlan-pcp
• description: The VLAN priority to be set. If this field is omitted, it will be treated as zero is specified.
• type: vlan-pcp
• default: 0

get-data-flow-count

• Description: 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.
• container: input
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• container: output
• leaf: count
• description: The number of data flows present in the specified VTN.
• type: (urn:ietf:params:xml:ns:yang:1)int32