vtn-vinterface

Base Information

Groupings Summary

RPCs Summary

Groupings

• vtn-mappable-vinterface-list

  • Description: Describes a list of virtual interfaces which can have port mapping confuguration.
  • list: vinterface
  • description: Describes virtual interface which can contain port mapping configuration.
  • min elements: 0
  • max elements: 2147483647
  • key definition: name
  • uses: 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-state
  • leaf: entity-state
  • description: State of the network element mapped to this virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:mapping:port)vtn-port-map-config
  • refines:
  • leaf: vlan-id
  • description: Specifies the VLAN ID. Zero implies untagged Ethernet frame. If omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:l2:types)vlan-id
  • leaf: node
  • description: Identifier for a physical switch.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)string
  • leaf: name
  • description: The name of the virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-name
  • container: vinterface-config
  • description: The container which contains configuration for virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • uses: vtn-vinterface-config
  • refines:
  • leaf: description
  • description: An arbitrary description about the virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • key definition: order
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ordered-flow-action
  • refines:
  • leaf: order
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • choice: vtn-action
  • description: Describes the abstract type of flow action.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-drop-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-action
  • description: Describes the flow action that drops every packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pop-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-pop-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pop-vlan-action
  • description: Describes the flow action that strips the outermost VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-push-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-push-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-push-vlan-action
  • description: Describes the flow action that adds a VLAN tag into packet.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-type
  • description: Describes the type for a new VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: code
  • description: The ICMP code to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: type
  • description: The ICMP type to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: dscp
  • description: The DSCP value to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-id-action
  • description: Describes the flow action that sets the specified VLAN ID into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-pcp-action
  • description: Describes the flow action that sets the specified VLAN priority into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-pcp
  • description: The VLAN priority to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • key definition: order
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ordered-flow-action
  • refines:
  • leaf: order
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • choice: vtn-action
  • description: Describes the abstract type of flow action.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-drop-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-action
  • description: Describes the flow action that drops every packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pop-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-pop-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pop-vlan-action
  • description: Describes the flow action that strips the outermost VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-push-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-push-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-push-vlan-action
  • description: Describes the flow action that adds a VLAN tag into packet.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-type
  • description: Describes the type for a new VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: code
  • description: The ICMP code to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: type
  • description: The ICMP type to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: dscp
  • description: The DSCP value to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-id-action
  • description: Describes the flow action that sets the specified VLAN ID into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-pcp-action
  • description: Describes the flow action that sets the specified VLAN priority into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-pcp
  • description: The VLAN priority to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • type: vlan-pcp
  • default: 0

• vtn-vinterface-info

  • Description: Describes information about virtual interface.
  • leaf: name
  • description: The name of the virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-name
  • container: vinterface-config
  • description: The container which contains configuration for virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • uses: vtn-vinterface-config
  • refines:
  • leaf: description
  • description: An arbitrary description about the virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • key definition: order
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ordered-flow-action
  • refines:
  • leaf: order
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • choice: vtn-action
  • description: Describes the abstract type of flow action.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-drop-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-action
  • description: Describes the flow action that drops every packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pop-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-pop-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pop-vlan-action
  • description: Describes the flow action that strips the outermost VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-push-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-push-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-push-vlan-action
  • description: Describes the flow action that adds a VLAN tag into packet.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-type
  • description: Describes the type for a new VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: code
  • description: The ICMP code to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: type
  • description: The ICMP type to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: dscp
  • description: The DSCP value to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-id-action
  • description: Describes the flow action that sets the specified VLAN ID into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-pcp-action
  • description: Describes the flow action that sets the specified VLAN priority into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-pcp
  • description: The VLAN priority to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • key definition: order
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ordered-flow-action
  • refines:
  • leaf: order
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • choice: vtn-action
  • description: Describes the abstract type of flow action.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-drop-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-action
  • description: Describes the flow action that drops every packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pop-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-pop-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pop-vlan-action
  • description: Describes the flow action that strips the outermost VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-push-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-push-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-push-vlan-action
  • description: Describes the flow action that adds a VLAN tag into packet.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-type
  • description: Describes the type for a new VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: code
  • description: The ICMP code to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: type
  • description: The ICMP type to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: dscp
  • description: The DSCP value to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-id-action
  • description: Describes the flow action that sets the specified VLAN ID into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-pcp-action
  • description: Describes the flow action that sets the specified VLAN priority into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-pcp
  • description: The VLAN priority to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • type: vlan-pcp
  • default: 0

• vtn-vinterface-config

  • Description: Describes configuration for a virtual interface.
  • leaf: description
  • description: An arbitrary description about the virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:1)boolean

• vtn-mappable-vinterface

  • Description: Describes information about a virtual interface which can contain port mapping configuration.
  • leaf: name
  • description: The name of the virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-name
  • container: vinterface-config
  • description: The container which contains configuration for virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • uses: vtn-vinterface-config
  • refines:
  • leaf: description
  • description: An arbitrary description about the virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • key definition: order
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ordered-flow-action
  • refines:
  • leaf: order
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • choice: vtn-action
  • description: Describes the abstract type of flow action.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-drop-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-action
  • description: Describes the flow action that drops every packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pop-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-pop-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pop-vlan-action
  • description: Describes the flow action that strips the outermost VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-push-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-push-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-push-vlan-action
  • description: Describes the flow action that adds a VLAN tag into packet.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-type
  • description: Describes the type for a new VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: code
  • description: The ICMP code to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: type
  • description: The ICMP type to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: dscp
  • description: The DSCP value to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-id-action
  • description: Describes the flow action that sets the specified VLAN ID into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-pcp-action
  • description: Describes the flow action that sets the specified VLAN priority into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-pcp
  • description: The VLAN priority to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)int32
  • choice: vtn-flow-filter-type
  • description: Describes the abstract type of flow filter.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-drop-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-filter
  • description: Describes the DROP flow filter which discards the specified packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pass-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-pass-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pass-filter
  • description: Describes the PASS flow filter which lets the specified packet through the virtual node in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-redirect-filter-case
  • description: The branch of the `vtn-flow-filter-type' choice for the `vtn-redirect-filter'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-redirect-filter
  • description: Describes the REDIRECT flow filter which forwards the specified packet to another virtual interface in the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vnode-path-fields
  • refines:
  • leaf: tenant-name
  • description: The name of the VTN.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • key definition: order
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ordered-flow-action
  • refines:
  • leaf: order
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • choice: vtn-action
  • description: Describes the abstract type of flow action.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-drop-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-drop-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-drop-action
  • description: Describes the flow action that drops every packet.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-pop-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-pop-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-pop-vlan-action
  • description: Describes the flow action that strips the outermost VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • case: vtn-push-vlan-action-case
  • description: The branch of the `vtn-action' choice for the `vtn-push-vlan-action'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-push-vlan-action
  • description: Describes the flow action that adds a VLAN tag into packet.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-type
  • description: Describes the type for a new VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-dladdr-action-fields
  • refines:
  • leaf: address
  • description: Describes the MAC address to be set into packet.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: code
  • description: The ICMP code to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: type
  • description: The ICMP type to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • leaf: dscp
  • description: The DSCP value to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:flow:action)vtn-ipaddr-action-fields
  • refines:
  • choice: address
  • min elements: 0
  • max elements: 2147483647
  • case: ipv4
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv4-address
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-inet-types)ipv4-prefix
  • case: ipv6
  • min elements: 0
  • max elements: 2147483647
  • leaf: ipv6-address
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-id-action
  • description: Describes the flow action that sets the specified VLAN ID into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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'.
  • min elements: 0
  • max elements: 2147483647
  • container: vtn-set-vlan-pcp-action
  • description: Describes the flow action that sets the specified VLAN priority into the IEEE 802.1Q VLAN tag.
  • min elements: 0
  • max elements: 2147483647
  • leaf: vlan-pcp
  • description: The VLAN priority to be set. If this field is omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • type: vlan-pcp
  • default: 0
  • container: vinterface-status
  • description: The container which contains runtime status information about the virtual interface which can contain port mapping configuration.
  • min elements: 0
  • max elements: 2147483647
  • uses: 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-state
  • leaf: entity-state
  • description: State of the network element mapped to this virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:mapping:port)vtn-port-map-config
  • refines:
  • leaf: vlan-id
  • description: Specifies the VLAN ID. Zero implies untagged Ethernet frame. If omitted, it will be treated as zero is specified.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:l2:types)vlan-id
  • leaf: node
  • description: Identifier for a physical switch.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)string

• vtn-mappable-vinterface-status

  • Description: Describes runtime status information about a virtual interface which can contain port mapping configuration.
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vnode-state
  • leaf: entity-state
  • description: State of the network element mapped to this virtual interface.
  • min elements: 0
  • max elements: 2147483647
  • 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.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:inventory)node-connector-id

RPC Definitions

remove-vinterface

• Description: Remove the specified virtual interface. 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 vBridge specified by `tenant-name' and `bridge-name' is not present. `NOTFOUND' is set if the vTerminal specified by `tenant-name' and `terminal-name' is not present. `NOTFOUND' is set if the virtual interface specified by the RPC input is not present. `INTERNALERROR' is set if the operation failed due to internal error.
• container: input
• min elements: 0
• max elements: 2147483647
• uses: (urn:opendaylight:vtn:types)vnode-path-fields
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• min elements: 0
• max elements: 2147483647
• 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.
• min elements: 0
• max elements: 2147483647
• 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.
• min elements: 0
• max elements: 2147483647
• 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.
• min elements: 0
• max elements: 2147483647
• 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.
• min elements: 0
• max elements: 2147483647
• type: (urn:ietf:params:xml:ns:yang:1)string

update-vinterface

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