vtn-vterminal

Base Information

Groupings Summary

RPCs Summary

Groupings

• vtn-vterminal-config

  • Description: Describes configuration for a vTerminal.
  • leaf: description
  • description: An arbitrary description about the vTerminal.
  • type: (urn:ietf:params:xml:ns:yang:1)string

• vtn-vterminal-info

  • Description: Describes information about vTerminal. Unlike vBridge, vTerminal can have only one virtual interface. vTerminal is always used in conjunction with redirection by flow filter. `state' field indicates the state of the vTerminal. If any of the following conditions are met, the vTerminal status will be `UNKNOWN': - No virtual interface is configured in the vTerminal. - A virtual interface inside the vTerminal is disabled. - Port mapping is not configured in a virtual interface inside the vTerminal. `DOWN' indicates that the physical network mapped to the vTerminal is not operating correctly. If an enabled virtual interface inside the vTerminal is in `DOWN' state, then the vTerminal status will be `DOWN'. `UP indicates that the physical network mapped to the vTerminal is operating correctly.
  • leaf: name
  • description: The name of the vTerminal.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • container: vterminal-config
  • description: The container which contains configuration for vTerminal.
  • uses: vtn-vterminal-config
  • refines:
  • leaf: description
  • description: An arbitrary description about the vTerminal.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • container: bridge-status
  • description: The container which contains runtime information about this virtual bridge.
  • uses: (urn:opendaylight:vtn:vbridge)vtn-bridge-status
  • refines:
  • leaf: state
  • description: State of the virtual bridge node. `UNKNOWN' indicates that no physical network is mapped to the virtual bridge node. `DOWN' indicates that the physical network mapped to the virtual bridge node is not operating correctly. `UP' indicates that the physical network mapped to the virtual bridge node is operating correctly.
  • type: state
  • default: UNKNOWN
  • leaf: path-faults
  • description: The number of path faults detected inside the virtual bridge node. The number of elements in `faulted-paths' will be set to this field. This shows the number of paths between the switches, constituting a virtual bridge node, that could not be configured by the VTN Manager because the paths were broken. Zero is set when no path fault has been detected. The number of path faults is counted for each direction of path. For example, if switch A and switch B are separated, then the path from switch A to switch B and path from switch B to switch A are treated as different and both are counted.
  • type: path-faults
  • default: 0
  • list: faulted-paths
  • description: A set of faulted paths.
  • key definition: source
  • key definition: destination
  • leaf: source
  • description: The source node of the faulted path.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: destination
  • description: The destination node of the faulted path.
  • type: (urn:opendaylight:inventory)node-id
  • list: vinterface
  • description: Describes virtual interface which can contain port mapping configuration.
  • key definition: name
  • uses: (urn:opendaylight:vtn:vinterface)vtn-mappable-vinterface
  • refines:
  • container: vinterface-status
  • description: The container which contains runtime status information about the virtual interface which can contain port mapping configuration.
  • uses: (urn:opendaylight:vtn:vinterface)vtn-mappable-vinterface-status
  • refines:
  • leaf: state
  • description: State of the virtual interface. `UNKNOWN' indicates that other network element is not mapped to the virtual interface. `DOWN' indicates that the network element mapped to the virtual interface is not operating. It will be in `DOWN' state even when the virtual interface is disabled. `UP' indicates that the network element mapped to the virtual interface is operating.
  • type: (urn:opendaylight:vtn:types)vnode-state
  • leaf: entity-state
  • description: State of the network element mapped to this virtual interface.
  • type: (urn:opendaylight:vtn:types)vnode-state
  • leaf: mapped-port
  • description: A physical switch port actually mapped by the port mapping. This field is omitted if no physical switch port meets the condition specified by the port mapping configuration.
  • type: (urn:opendaylight:inventory)node-connector-id
  • container: port-map-config
  • description: The container which contains port mapping configuration, which maps a physical switch port to a virtual interface in a virtual node.
  • uses: (urn:opendaylight:vtn:mapping:port)vtn-port-map-config
  • 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
  • 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: name
  • description: The name of the virtual interface.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • container: vinterface-config
  • description: The container which contains configuration for virtual interface.
  • uses: (urn:opendaylight:vtn:vinterface)vtn-vinterface-config
  • refines:
  • leaf: description
  • description: An arbitrary description about the virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: enabled
  • description: A boolean value which determines whether the virtual interface is to be enabled or not. True means that the virtual interface is enabled. If a virtual interface is disabled, then all the inputs from that virtual interface will be ignored. Also, there will be no output against that virtual interface. If this field is omitted, it will be treated as true is specified.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean
  • container: vinterface-input-filter
  • description: A list of flow filters applied to packets received from this virtual interface. Note that this container may not be present if no input flow filter is configured in this virtual interface.
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-flow-filter-list
  • refines:
  • list: vtn-flow-filter
  • description: Describes a list of flow filters configured in a virtual node in VTN. Each flow filter in this list needs to have a unique index in `index' field. `index' value is used to determine order of flow filter evaluation. Flow filters in this list are evaluated against packet in ascending order of `index' value, and only the first matched flow filter is applied to the packet.
  • key definition: index
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-flow-filter-config
  • refines:
  • leaf: condition
  • description: The name of the flow condition that selects packets. This flow filter is invalidated if the flow condition specified by this field is not present.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-redirect-filter-config
  • refines:
  • container: redirect-destination
  • description: Describes the path to the virtual interface where the specified packets are forwarded. - The VTN name configured in `tenant-name' field is always ignored. The VTN name is always determined by the location of the virtual node that contains the flow filter. - The path to the virtual interface that contains this flow filter cannot be specified. - Note that every packet redirected by the flow filter is discarded if the virtual interface specified by this field is not present in the VTN. Packet redirection should be configured not to cause the packet loop. The number of virtual node hops per a flow (the number of packet redirections) is limited to 100. If the number of virtual node hops exceeds the limit, it is treated as the packet loop and then the packet is discarded.
  • 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: output
  • description: Determine the direction of the packet redirection. - If true is specified, the packet is redirected as outgoing packet. + The redirected packet will be treated as if it is transmitted from the virtual interface specified by `redirect-destination'. + A list of flow filters for outgoing packets configured in the virtual interface specified by `redirect-destination' wil be evaluated against the redirected packet. If the packet is passed by the flow filter, it is transmitted to the physical network mapped to the virtual interface by port mapping. The packet will be discarded if port mapping is not configured to the virtual interface. - If false is specified or omitted, the packet is redirected as incoming packet. + The redirected packet will be treated as if it is received from the virtual interface specified by `redirect-destination'. The packet is redirected even if no physical network is mapped to the destination virtual interface by port mapping. + A list of flow filters for incoming packets configured in the virtual interface specified by `redirect-destination' will be evaluated against the redirected packet. If the packet is passed by the flow filter, it is forwarded to the virtual node that contains the virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean
  • 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
  • container: vinterface-output-filter
  • description: A list of flow filters applied to packets transmitted from this virtual interface. Note that this container may not be present if no output flow filter is configured in this virtual interface.
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-flow-filter-list
  • refines:
  • list: vtn-flow-filter
  • description: Describes a list of flow filters configured in a virtual node in VTN. Each flow filter in this list needs to have a unique index in `index' field. `index' value is used to determine order of flow filter evaluation. Flow filters in this list are evaluated against packet in ascending order of `index' value, and only the first matched flow filter is applied to the packet.
  • key definition: index
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-flow-filter-config
  • refines:
  • leaf: condition
  • description: The name of the flow condition that selects packets. This flow filter is invalidated if the flow condition specified by this field is not present.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-redirect-filter-config
  • refines:
  • container: redirect-destination
  • description: Describes the path to the virtual interface where the specified packets are forwarded. - The VTN name configured in `tenant-name' field is always ignored. The VTN name is always determined by the location of the virtual node that contains the flow filter. - The path to the virtual interface that contains this flow filter cannot be specified. - Note that every packet redirected by the flow filter is discarded if the virtual interface specified by this field is not present in the VTN. Packet redirection should be configured not to cause the packet loop. The number of virtual node hops per a flow (the number of packet redirections) is limited to 100. If the number of virtual node hops exceeds the limit, it is treated as the packet loop and then the packet is discarded.
  • 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: output
  • description: Determine the direction of the packet redirection. - If true is specified, the packet is redirected as outgoing packet. + The redirected packet will be treated as if it is transmitted from the virtual interface specified by `redirect-destination'. + A list of flow filters for outgoing packets configured in the virtual interface specified by `redirect-destination' wil be evaluated against the redirected packet. If the packet is passed by the flow filter, it is transmitted to the physical network mapped to the virtual interface by port mapping. The packet will be discarded if port mapping is not configured to the virtual interface. - If false is specified or omitted, the packet is redirected as incoming packet. + The redirected packet will be treated as if it is received from the virtual interface specified by `redirect-destination'. The packet is redirected even if no physical network is mapped to the destination virtual interface by port mapping. + A list of flow filters for incoming packets configured in the virtual interface specified by `redirect-destination' will be evaluated against the redirected packet. If the packet is passed by the flow filter, it is forwarded to the virtual node that contains the virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean
  • 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

• vtn-vterminal-list

  • Description: Describes a list of vTerminals.
  • list: vterminal
  • description: vTerminal is isolated input and output terminal inside VTN. vTerminal can have only one virtual interface, and it can map a physical switch port by port mapping.
  • key definition: name
  • uses: vtn-vterminal-info
  • refines:
  • leaf: name
  • description: The name of the vTerminal.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • container: vterminal-config
  • description: The container which contains configuration for vTerminal.
  • uses: vtn-vterminal-config
  • refines:
  • leaf: description
  • description: An arbitrary description about the vTerminal.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • container: bridge-status
  • description: The container which contains runtime information about this virtual bridge.
  • uses: (urn:opendaylight:vtn:vbridge)vtn-bridge-status
  • refines:
  • leaf: state
  • description: State of the virtual bridge node. `UNKNOWN' indicates that no physical network is mapped to the virtual bridge node. `DOWN' indicates that the physical network mapped to the virtual bridge node is not operating correctly. `UP' indicates that the physical network mapped to the virtual bridge node is operating correctly.
  • type: state
  • default: UNKNOWN
  • leaf: path-faults
  • description: The number of path faults detected inside the virtual bridge node. The number of elements in `faulted-paths' will be set to this field. This shows the number of paths between the switches, constituting a virtual bridge node, that could not be configured by the VTN Manager because the paths were broken. Zero is set when no path fault has been detected. The number of path faults is counted for each direction of path. For example, if switch A and switch B are separated, then the path from switch A to switch B and path from switch B to switch A are treated as different and both are counted.
  • type: path-faults
  • default: 0
  • list: faulted-paths
  • description: A set of faulted paths.
  • key definition: source
  • key definition: destination
  • leaf: source
  • description: The source node of the faulted path.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: destination
  • description: The destination node of the faulted path.
  • type: (urn:opendaylight:inventory)node-id
  • list: vinterface
  • description: Describes virtual interface which can contain port mapping configuration.
  • key definition: name
  • uses: (urn:opendaylight:vtn:vinterface)vtn-mappable-vinterface
  • refines:
  • container: vinterface-status
  • description: The container which contains runtime status information about the virtual interface which can contain port mapping configuration.
  • uses: (urn:opendaylight:vtn:vinterface)vtn-mappable-vinterface-status
  • refines:
  • leaf: state
  • description: State of the virtual interface. `UNKNOWN' indicates that other network element is not mapped to the virtual interface. `DOWN' indicates that the network element mapped to the virtual interface is not operating. It will be in `DOWN' state even when the virtual interface is disabled. `UP' indicates that the network element mapped to the virtual interface is operating.
  • type: (urn:opendaylight:vtn:types)vnode-state
  • leaf: entity-state
  • description: State of the network element mapped to this virtual interface.
  • type: (urn:opendaylight:vtn:types)vnode-state
  • leaf: mapped-port
  • description: A physical switch port actually mapped by the port mapping. This field is omitted if no physical switch port meets the condition specified by the port mapping configuration.
  • type: (urn:opendaylight:inventory)node-connector-id
  • container: port-map-config
  • description: The container which contains port mapping configuration, which maps a physical switch port to a virtual interface in a virtual node.
  • uses: (urn:opendaylight:vtn:mapping:port)vtn-port-map-config
  • 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
  • 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: name
  • description: The name of the virtual interface.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • container: vinterface-config
  • description: The container which contains configuration for virtual interface.
  • uses: (urn:opendaylight:vtn:vinterface)vtn-vinterface-config
  • refines:
  • leaf: description
  • description: An arbitrary description about the virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: enabled
  • description: A boolean value which determines whether the virtual interface is to be enabled or not. True means that the virtual interface is enabled. If a virtual interface is disabled, then all the inputs from that virtual interface will be ignored. Also, there will be no output against that virtual interface. If this field is omitted, it will be treated as true is specified.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean
  • container: vinterface-input-filter
  • description: A list of flow filters applied to packets received from this virtual interface. Note that this container may not be present if no input flow filter is configured in this virtual interface.
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-flow-filter-list
  • refines:
  • list: vtn-flow-filter
  • description: Describes a list of flow filters configured in a virtual node in VTN. Each flow filter in this list needs to have a unique index in `index' field. `index' value is used to determine order of flow filter evaluation. Flow filters in this list are evaluated against packet in ascending order of `index' value, and only the first matched flow filter is applied to the packet.
  • key definition: index
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-flow-filter-config
  • refines:
  • leaf: condition
  • description: The name of the flow condition that selects packets. This flow filter is invalidated if the flow condition specified by this field is not present.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-redirect-filter-config
  • refines:
  • container: redirect-destination
  • description: Describes the path to the virtual interface where the specified packets are forwarded. - The VTN name configured in `tenant-name' field is always ignored. The VTN name is always determined by the location of the virtual node that contains the flow filter. - The path to the virtual interface that contains this flow filter cannot be specified. - Note that every packet redirected by the flow filter is discarded if the virtual interface specified by this field is not present in the VTN. Packet redirection should be configured not to cause the packet loop. The number of virtual node hops per a flow (the number of packet redirections) is limited to 100. If the number of virtual node hops exceeds the limit, it is treated as the packet loop and then the packet is discarded.
  • 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: output
  • description: Determine the direction of the packet redirection. - If true is specified, the packet is redirected as outgoing packet. + The redirected packet will be treated as if it is transmitted from the virtual interface specified by `redirect-destination'. + A list of flow filters for outgoing packets configured in the virtual interface specified by `redirect-destination' wil be evaluated against the redirected packet. If the packet is passed by the flow filter, it is transmitted to the physical network mapped to the virtual interface by port mapping. The packet will be discarded if port mapping is not configured to the virtual interface. - If false is specified or omitted, the packet is redirected as incoming packet. + The redirected packet will be treated as if it is received from the virtual interface specified by `redirect-destination'. The packet is redirected even if no physical network is mapped to the destination virtual interface by port mapping. + A list of flow filters for incoming packets configured in the virtual interface specified by `redirect-destination' will be evaluated against the redirected packet. If the packet is passed by the flow filter, it is forwarded to the virtual node that contains the virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean
  • 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
  • container: vinterface-output-filter
  • description: A list of flow filters applied to packets transmitted from this virtual interface. Note that this container may not be present if no output flow filter is configured in this virtual interface.
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-flow-filter-list
  • refines:
  • list: vtn-flow-filter
  • description: Describes a list of flow filters configured in a virtual node in VTN. Each flow filter in this list needs to have a unique index in `index' field. `index' value is used to determine order of flow filter evaluation. Flow filters in this list are evaluated against packet in ascending order of `index' value, and only the first matched flow filter is applied to the packet.
  • key definition: index
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-flow-filter-config
  • refines:
  • leaf: condition
  • description: The name of the flow condition that selects packets. This flow filter is invalidated if the flow condition specified by this field is not present.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • uses: (urn:opendaylight:vtn:flow:filter)vtn-redirect-filter-config
  • refines:
  • container: redirect-destination
  • description: Describes the path to the virtual interface where the specified packets are forwarded. - The VTN name configured in `tenant-name' field is always ignored. The VTN name is always determined by the location of the virtual node that contains the flow filter. - The path to the virtual interface that contains this flow filter cannot be specified. - Note that every packet redirected by the flow filter is discarded if the virtual interface specified by this field is not present in the VTN. Packet redirection should be configured not to cause the packet loop. The number of virtual node hops per a flow (the number of packet redirections) is limited to 100. If the number of virtual node hops exceeds the limit, it is treated as the packet loop and then the packet is discarded.
  • 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: output
  • description: Determine the direction of the packet redirection. - If true is specified, the packet is redirected as outgoing packet. + The redirected packet will be treated as if it is transmitted from the virtual interface specified by `redirect-destination'. + A list of flow filters for outgoing packets configured in the virtual interface specified by `redirect-destination' wil be evaluated against the redirected packet. If the packet is passed by the flow filter, it is transmitted to the physical network mapped to the virtual interface by port mapping. The packet will be discarded if port mapping is not configured to the virtual interface. - If false is specified or omitted, the packet is redirected as incoming packet. + The redirected packet will be treated as if it is received from the virtual interface specified by `redirect-destination'. The packet is redirected even if no physical network is mapped to the destination virtual interface by port mapping. + A list of flow filters for incoming packets configured in the virtual interface specified by `redirect-destination' will be evaluated against the redirected packet. If the packet is passed by the flow filter, it is forwarded to the virtual node that contains the virtual interface.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean
  • 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

RPC Definitions

remove-vterminal

• Description: Remove the specified vTerminal. All the virtual interfaces inside the specified vTerminal will also be removed. 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 VTN specified by `tenant-name' is not present. `NOTFOUND' is set if the specified vTerminal is not present. `INTERNALERROR' is set if the operation failed due to internal error.
• container: input
• uses: (urn:opendaylight:vtn:types)vterminal-path-fields
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: terminal-name
• description: The name of the vTerminal.
• type: (urn:ietf:params:xml:ns:yang:1)string
• container: output

update-vterminal

• Description: Create or modify the specified vTerminal. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `CREATED' indicates that the specified vTerminal has been newly created. `CHANGED' indicates that the configuration for the specified vTerminal has been changed. Null indicates that the configuration for the specified vTerminal 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 VTN specified by `tenant-name' is not present. `NOTFOUND' is set if `update-mode' field in the RPC input is `MODIFY' and the specified vTerminal is not present. `CONFLICT' is set if `update-mode' field in the RPC input is `CREATE' and the specified vTerminal is present. `INTERNALERROR' is set if the operation failed due to internal error.
• container: input
• uses: vtn-vterminal-config
• refines:
• uses: (urn:opendaylight:vtn:types)vterminal-path-fields
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: terminal-name
• description: The name of the vTerminal.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: update-mode
• description: Describes how to update the vTerminal specified by `tenant-name' and `terminal-name'; If `UPDATE' is specified, the specified vTerminal is created if it is not present. Otherwise the specified vTerminal configuration is applied to the specified vTerminal. If `CREATE' is specified, the specified vTerminal is created only if it is not present. If the specified vTerminal is present, this operation will cause a `CONFLICT' error. If `MODIFY' is specified, the specified vTerminal configuration is applied to the specified vTerminal only if it is present. If the specified vTerminal is not present, this operation will cause a `NOTFOUND' error.
• type: update-mode
• default: UPDATE
• leaf: operation
• description: Describes how to update the existing vTerminal specified by `tenant-name' and `terminal-name'. This field will be ignored if the specified vTerminal is not present. If `ADD' is specified, omitted fields will not be modified. For example, `description' field is not modified if `description' field is omitted. This is the default behavior. If `SET' is specified, all the fields defined by `vtn-vterminal-config' will be applied to the vTerminal configuration as-is. In this case the `description' field will be removed from the configuration if `description' field is omitted.
• type: operation
• default: ADD
• leaf: description
• description: An arbitrary description about the vTerminal.
• type: (urn:ietf:params:xml:ns:yang:1)string
• container: output
• uses: (urn:opendaylight:vtn:types)vtn-rpc-result
• refines:
• leaf: status
• description: Describes the status of the RPC result.
• type: (urn:opendaylight:vtn:types)vtn-update-type