vtn-mac-table

Base Information

Groupings Summary

Child Nodes Summary

RPCs Summary

Groupings

• vtn-mac-table-list

  • Description: A list of MAC address tables.
  • list: mac-address-table
  • description: MAC address table keeps MAC address information learned by a vBridge.
  • key definition: name
  • uses: vtn-mac-table-entry
  • refines:
  • leaf: name
  • description: The name of the vBridge associated with this MAC address table.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • list: mac-table-entry
  • description: MAC address information learned by a vBridge.
  • key definition: mac-address
  • uses: vtn-mac-entry
  • refines:
  • leaf: used
  • description: True is set if this entry is used by the VTN Manager This field is only for internal use.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean
  • leaf: ip-probe-count
  • description: The number of IP address probe request. This field is only for internal use.
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • leaf: entry-data
  • description: An opaque data associated with this entry. This field is only for internal use.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: mac-address
  • description: A string representation of a learned MAC address.
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • leaf: vlan-id
  • description: A VLAN ID detected inside Ethernet frame where the MAC address was detected. Zero implies that VLAN tag was not detected.
  • type: (urn:ietf:params:xml:ns:yang:1)uint16
  • leaf-list: ip-addresses
  • description: A set of IP addresses detected inside Ethernet frame where the MAC address was detected.
  • type: ip-address
  • leaf: node
  • description: Identifier for a physical switch.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: port-id
  • description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: port-name
  • description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
  • type: (urn:opendaylight:vtn:types)string

• vtn-mac-entry

  • Description: Describes information about a MAC address learned inside vBridge.
  • leaf: mac-address
  • description: A string representation of a learned MAC address.
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • leaf: vlan-id
  • description: A VLAN ID detected inside Ethernet frame where the MAC address was detected. Zero implies that VLAN tag was not detected.
  • type: (urn:ietf:params:xml:ns:yang:1)uint16
  • leaf: node
  • description: Identifier for a physical switch.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: port-id
  • description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: port-name
  • description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
  • type: (urn:opendaylight:vtn:types)string
  • leaf-list: ip-addresses
  • description: A set of IP addresses detected inside Ethernet frame where the MAC address was detected.
  • type: ip-address

• vtn-mac-table-entry

  • Description: Describes a set of MAC address entry in a MAC address table.
  • list: mac-table-entry
  • description: MAC address information learned by a vBridge.
  • key definition: mac-address
  • uses: vtn-mac-entry
  • refines:
  • leaf: mac-address
  • description: A string representation of a learned MAC address.
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • leaf: vlan-id
  • description: A VLAN ID detected inside Ethernet frame where the MAC address was detected. Zero implies that VLAN tag was not detected.
  • type: (urn:ietf:params:xml:ns:yang:1)uint16
  • leaf-list: ip-addresses
  • description: A set of IP addresses detected inside Ethernet frame where the MAC address was detected.
  • type: ip-address
  • leaf: node
  • description: Identifier for a physical switch.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: port-id
  • description: Identifier for a switch port in the physical switch. To specify the OpenFlow switch port, a string representation of the port number for a physical port needs to be specified. If this field is omitted, it is necessary to specify the `port-name' field.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • leaf: port-name
  • description: The name of the switch port. Note that an empty string cannot be specified as the port name. If this attribute is omitted, it is necessary to specify the `port-id' field.
  • type: (urn:opendaylight:vtn:types)string
  • leaf: used
  • description: True is set if this entry is used by the VTN Manager This field is only for internal use.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean
  • leaf: ip-probe-count
  • description: The number of IP address probe request. This field is only for internal use.
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • leaf: entry-data
  • description: An opaque data associated with this entry. This field is only for internal use.
  • type: (urn:ietf:params:xml:ns:yang:1)string

Datastore Structure

• mac-tables
  • tenant-mac-table [name]
    • name
    • mac-address-table [name] (U)
      • name(U)
      • mac-table-entry [mac-address] (U)
        • used(U)
        • ip-probe-count(U)
        • entry-data(U)
        • mac-address(U)
        • vlan-id(U)
        • ip-addresses(U)
        • node(U)
        • port-id(U)
        • port-name(U)

Child nodes

Direct children

• mac-tables (container)
  • configuration data: false

mac-tables

XML Path

Restconf path

vtn-mac-table:mac-tables

Direct children

• tenant-mac-table (list)
  • configuration data: false

XML example

        <mac-tables xmlns="urn:opendaylight:vtn:vbridge:mac">
        
            <!-- See definition
             for child nodes.  -->
            <!-- This node could appear multiple times -->
            <tenant-mac-table xmlns="urn:opendaylight:vtn:vbridge:mac">...</tenant-mac-table>
        
        </mac-tables>
    

mac-tables/tenant-mac-table

XML Path

Restconf path

vtn-mac-table:mac-tables/tenant-mac-table/{name}

Direct children

• name (leaf)
  • configuration data: false
  • mandatory: false
• mac-address-table (list)
  • configuration data: false

XML example

        <tenant-mac-table xmlns="urn:opendaylight:vtn:vbridge:mac">
        
            <name xmlns="urn:opendaylight:vtn:vbridge:mac">...</name>
        
            <!-- See definition
             for child nodes.  -->
            <!-- This node could appear multiple times -->
            <mac-address-table xmlns="urn:opendaylight:vtn:vbridge:mac">...</mac-address-table>
        
        </tenant-mac-table>
    

mac-tables/tenant-mac-table/mac-address-table

XML Path

Restconf path

vtn-mac-table:mac-tables/tenant-mac-table/{name}/mac-address-table/{name}

Direct children

• name (leaf)
  • configuration data: false
  • mandatory: false
• mac-table-entry (list)
  • configuration data: false

XML example

        <mac-address-table xmlns="urn:opendaylight:vtn:vbridge:mac">
        
            <name xmlns="urn:opendaylight:vtn:vbridge:mac">...</name>
        
            <!-- See definition
             for child nodes.  -->
            <!-- This node could appear multiple times -->
            <mac-table-entry xmlns="urn:opendaylight:vtn:vbridge:mac">...</mac-table-entry>
        
        </mac-address-table>
    

mac-tables/tenant-mac-table/mac-address-table/mac-table-entry

XML Path

Restconf path

vtn-mac-table:mac-tables/tenant-mac-table/{name}/mac-address-table/{name}/mac-table-entry/{mac-address}

Direct children

• used (leaf)
  • configuration data: false
  • mandatory: false
• ip-probe-count (leaf)
  • configuration data: false
  • mandatory: false
• entry-data (leaf)
  • configuration data: false
  • mandatory: false
• mac-address (leaf)
  • configuration data: false
  • mandatory: false
• vlan-id (leaf)
  • configuration data: false
  • mandatory: false
• node (leaf)
  • configuration data: false
  • mandatory: false
• port-id (leaf)
  • configuration data: false
  • mandatory: false
• port-name (leaf)
  • configuration data: false
  • mandatory: false
• ip-addresses (leaf-list)
  • configuration data: false

XML example

        <mac-table-entry xmlns="urn:opendaylight:vtn:vbridge:mac">
        
            <used xmlns="urn:opendaylight:vtn:vbridge:mac">...</used>
        
            <ip-probe-count xmlns="urn:opendaylight:vtn:vbridge:mac">...</ip-probe-count>
        
            <entry-data xmlns="urn:opendaylight:vtn:vbridge:mac">...</entry-data>
        
            <mac-address xmlns="urn:opendaylight:vtn:vbridge:mac">...</mac-address>
        
            <vlan-id xmlns="urn:opendaylight:vtn:vbridge:mac">...</vlan-id>
        
            <!-- This node could appear multiple times -->
            <ip-addresses xmlns="urn:opendaylight:vtn:vbridge:mac">...</ip-addresses>
        
            <node xmlns="urn:opendaylight:vtn:vbridge:mac">...</node>
        
            <port-id xmlns="urn:opendaylight:vtn:vbridge:mac">...</port-id>
        
            <port-name xmlns="urn:opendaylight:vtn:vbridge:mac">...</port-name>
        
        </mac-table-entry>
    

RPC Definitions

remove-mac-entry

• Description: Remove the specified MAC address information from the MAC address table in the specified vBridge. MAC addresses passed to `mac-addresses' list will be copied to the RPC output, and `status' field in the RPC output descripes the result of the operation. `REMOVED' indicates that the MAC address specified by `mac-address' field in the RPC output has been successfully removed. Null indicates that the MAC address specified by `mac-address' field in the RPC output is not learned by the vBridge specified by the RPC input. If no MAC address is specified by the RPC input, all the MAC addresses in the MAC address table will be removed. In this case all the removed MAC addresses will be copied to the RPC output. `remove-mac-entry-result' will be null if no MAC address is specified by the RPC input and the specified MAC address table is empty. 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 or the vBridge specified by the RPC input is not present. `INTERNALERROR' is set if the operation failed due to internal error.
• container: input
• uses: (urn:opendaylight:vtn:types)vbridge-path-fields
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: bridge-name
• description: The name of the vBridge.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf-list: mac-addresses
• description: A list of MAC addresses to be removed from the MAC address table in the specified vBridge. If this field is omitted or an empty list is specified, all the learned MAC addresses by the specified vBridge will be removed. Duplicates in this list will be eliminated automatically.
• type: mac-address
• container: output
• list: remove-mac-entry-result
• description: Describes pairs of MAC addresses and operation results.
• uses: (urn:opendaylight:vtn:types)vtn-rpc-result
• refines:
• leaf: mac-address
• description: One of the MAC address specified by the RPC input.
• type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
• leaf: status
• description: Describes the status of the RPC result.
• type: (urn:opendaylight:vtn:types)vtn-update-type