vtn-mac-map

Base Information

Groupings Summary

RPCs Summary

Groupings

• vtn-mac-map-status

  • Description: Describes runtime status information about MAC mapping.
  • list: mapped-host
  • description: A list of MAC addresses actually mapped to the vBridge.
  • min elements: 0
  • max elements: 2147483647
  • key definition: mac-address
  • uses: (urn:opendaylight:vtn:types)vtn-vlan-id-field
  • refines:
  • leaf: mac-address
  • description: MAC address actually mapped to the vBridge.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • leaf: port-id
  • description: An identifier for a physical switch port where the MAC address is detected.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:inventory)node-connector-id
  • 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

• vtn-mac-map-info

  • Description: Describes information about MAC mapping, which maps hosts specified by MAC address and VLAN ID to a vBridge.
  • container: mac-map-config
  • description: The container which contains configuration for MAC mapping.
  • min elements: 0
  • max elements: 2147483647
  • uses: vtn-mac-map-config
  • refines:
  • container: allowed-hosts
  • description: A set of hosts to be mapped by MAC mapping. If a host in this container does not specify a MAC address, all the hosts detected over the specified VLAN will be mapped. For example, if "@10" is configured in this container, all hosts detected on VLAN 10 will be mapped. Note that zero, broadcast address, and multicast address cannot be specified as MAC address. In addition, multiple host information with the same MAC address cannot be configured in this set.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vlan-host-desc-set
  • refines:
  • list: vlan-host-desc-list
  • description: Describes a list of unique `vlan-host-desc' values.
  • min elements: 0
  • max elements: 2147483647
  • key definition: host
  • leaf: host
  • description: A pair of MAC address and VLAN ID.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vlan-host-desc
  • container: denied-hosts
  • description: A set of hosts not to be mapped by MAC mapping. This container is used to exclude specific hosts from mapping when host information in `allowed-hosts' does not specify any MAC address. Unlike `allowed-hosts', every hosts in this container must specify a MAC address. The hosts in this container is evaluated before `allowed-hosts'. If the same host information is specified in both `allowed-hosts' and this container, that host will not be mapped by this MAC mapping. Note that zero, broadcast address, and multicast address cannot be specified as MAC address.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vlan-host-desc-set
  • refines:
  • list: vlan-host-desc-list
  • description: Describes a list of unique `vlan-host-desc' values.
  • min elements: 0
  • max elements: 2147483647
  • key definition: host
  • leaf: host
  • description: A pair of MAC address and VLAN ID.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vlan-host-desc
  • container: mac-map-status
  • description: The container which contains runtime status information about MAC mapping.
  • min elements: 0
  • max elements: 2147483647
  • uses: vtn-mac-map-status
  • refines:
  • list: mapped-host
  • description: A list of MAC addresses actually mapped to the vBridge.
  • min elements: 0
  • max elements: 2147483647
  • key definition: mac-address
  • uses: (urn:opendaylight:vtn:types)vtn-vlan-id-field
  • refines:
  • leaf: mac-address
  • description: MAC address actually mapped to the vBridge.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • leaf: port-id
  • description: An identifier for a physical switch port where the MAC address is detected.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:inventory)node-connector-id
  • 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

• vtn-mac-map-config

  • Description: Describes configuration for a MAC mapping.
  • container: allowed-hosts
  • description: A set of hosts to be mapped by MAC mapping. If a host in this container does not specify a MAC address, all the hosts detected over the specified VLAN will be mapped. For example, if "@10" is configured in this container, all hosts detected on VLAN 10 will be mapped. Note that zero, broadcast address, and multicast address cannot be specified as MAC address. In addition, multiple host information with the same MAC address cannot be configured in this set.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vlan-host-desc-set
  • refines:
  • list: vlan-host-desc-list
  • description: Describes a list of unique `vlan-host-desc' values.
  • min elements: 0
  • max elements: 2147483647
  • key definition: host
  • leaf: host
  • description: A pair of MAC address and VLAN ID.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vlan-host-desc
  • container: denied-hosts
  • description: A set of hosts not to be mapped by MAC mapping. This container is used to exclude specific hosts from mapping when host information in `allowed-hosts' does not specify any MAC address. Unlike `allowed-hosts', every hosts in this container must specify a MAC address. The hosts in this container is evaluated before `allowed-hosts'. If the same host information is specified in both `allowed-hosts' and this container, that host will not be mapped by this MAC mapping. Note that zero, broadcast address, and multicast address cannot be specified as MAC address.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vlan-host-desc-set
  • refines:
  • list: vlan-host-desc-list
  • description: Describes a list of unique `vlan-host-desc' values.
  • min elements: 0
  • max elements: 2147483647
  • key definition: host
  • leaf: host
  • description: A pair of MAC address and VLAN ID.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vlan-host-desc

• vtn-mac-mappable

  • Description: Describes the data model which can contain MAC mapping configuration.
  • container: mac-map
  • description: Describes information about MAC mapping, which maps hosts specified by MAC address and VLAN ID to a vBridge.
  • min elements: 0
  • max elements: 2147483647
  • uses: vtn-mac-map-info
  • refines:
  • container: mac-map-config
  • description: The container which contains configuration for MAC mapping.
  • min elements: 0
  • max elements: 2147483647
  • uses: vtn-mac-map-config
  • refines:
  • container: allowed-hosts
  • description: A set of hosts to be mapped by MAC mapping. If a host in this container does not specify a MAC address, all the hosts detected over the specified VLAN will be mapped. For example, if "@10" is configured in this container, all hosts detected on VLAN 10 will be mapped. Note that zero, broadcast address, and multicast address cannot be specified as MAC address. In addition, multiple host information with the same MAC address cannot be configured in this set.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vlan-host-desc-set
  • refines:
  • list: vlan-host-desc-list
  • description: Describes a list of unique `vlan-host-desc' values.
  • min elements: 0
  • max elements: 2147483647
  • key definition: host
  • leaf: host
  • description: A pair of MAC address and VLAN ID.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vlan-host-desc
  • container: denied-hosts
  • description: A set of hosts not to be mapped by MAC mapping. This container is used to exclude specific hosts from mapping when host information in `allowed-hosts' does not specify any MAC address. Unlike `allowed-hosts', every hosts in this container must specify a MAC address. The hosts in this container is evaluated before `allowed-hosts'. If the same host information is specified in both `allowed-hosts' and this container, that host will not be mapped by this MAC mapping. Note that zero, broadcast address, and multicast address cannot be specified as MAC address.
  • min elements: 0
  • max elements: 2147483647
  • uses: (urn:opendaylight:vtn:types)vlan-host-desc-set
  • refines:
  • list: vlan-host-desc-list
  • description: Describes a list of unique `vlan-host-desc' values.
  • min elements: 0
  • max elements: 2147483647
  • key definition: host
  • leaf: host
  • description: A pair of MAC address and VLAN ID.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:vtn:types)vlan-host-desc
  • container: mac-map-status
  • description: The container which contains runtime status information about MAC mapping.
  • min elements: 0
  • max elements: 2147483647
  • uses: vtn-mac-map-status
  • refines:
  • list: mapped-host
  • description: A list of MAC addresses actually mapped to the vBridge.
  • min elements: 0
  • max elements: 2147483647
  • key definition: mac-address
  • uses: (urn:opendaylight:vtn:types)vtn-vlan-id-field
  • refines:
  • leaf: mac-address
  • description: MAC address actually mapped to the vBridge.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:ietf:params:xml:ns:yang:ietf-yang-types)mac-address
  • leaf: port-id
  • description: An identifier for a physical switch port where the MAC address is detected.
  • min elements: 0
  • max elements: 2147483647
  • type: (urn:opendaylight:inventory)node-connector-id
  • 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

RPC Definitions

set-mac-map

• Description: Configure MAC mapping in the specified vBridge. This operation changes the MAC addresses to be mapped and not to be mapped at the same time. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `CREATED' indicates that new MAC mapping configuration has been created in the specified vBridge. `CHANGED' indicates that existing MAC mapping configuration has been changed. `REMOVED' indicates that MAC mapping configuration has been removed from the specified vBridge. Null indicates that MAC mapping configuration in the specified vBridge 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. `CONFLICT' is set if this operation tries to map a host already mapped by another MAC mapping. `CONFLICT' is set if this operation tries to add a MAC address into `allowed-hosts' in the MAC mapping configuration, and that MAC address is already configured in `allowed-hosts'. `INTERNALERROR' is set if the operation failed due to internal error.
• container: input
• min elements: 0
• max elements: 2147483647
• uses: (urn:opendaylight:vtn:types)vbridge-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.
• min elements: 0
• max elements: 2147483647
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: operation
• description: Describes how to update the specified MAC mapping. If `SET' is specified, the given MAC mapping configuration will be applied as specified. In other words, existing MAC mapping configuration will be removed, and then the given MAC mapping will be created. Note that MAC mapping will be removed if both `allowed-hosts' and `denied-hosts' fields in the RPC input are empty. If `ADD' is specified, the given MAC mapping configuration will be merged with existing configuration. Hosts configured in `allowed-hosts' and `denied-hosts' fields in the RPC input will be added to `allowed-hosts' and `denied-hosts' container in the MAC mapping configuration respectively. If `REMOVE' is specified, the given MAC mapping configuration will be removed from existing configuration. Hosts configured in `allowed-hosts' and `denied-hosts' fields in the RPC input will be removed from `allowed-hosts' and `denied-hosts' container in the MAC mapping configuration respectively. Note that MAC mapping will be removed if both `allowed-hosts' and `denied-hosts' container in the MAC mapping configuration become empty. Null will be treated as if `ADD' is specified.
• min elements: 0
• max elements: 2147483647
• type: (urn:opendaylight:vtn:types)vtn-update-operation-type
• leaf-list: allowed-hosts
• description: A set of hosts to be added to or removed from `allowed-hosts' container in the MAC mapping configuration. Duplicate hosts will be eliminated automatically. Note that multiple host information with the same MAC address cannot be specified in this list.
• min elements: 0
• max elements: 2147483647
• type: vlan-host-desc
• leaf-list: denied-hosts
• description: A set of hosts to be added to or removed from `denied-hosts' container in the MAC mapping configuration. Duplicate hosts will be eliminated automatically.
• min elements: 0
• max elements: 2147483647
• type: vlan-host-desc
• 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

set-mac-map-acl

• Description: Configure MAC mapping in the specified vBridge. This operation changes the specified access control list of the MAC mapping. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `CREATED' indicates that new MAC mapping configuration has been created in the specified vBridge. `CHANGED' indicates that existing MAC mapping configuration has been changed. `REMOVED' indicates that MAC mapping configuration has been removed from the specified vBridge. Null indicates that MAC mapping configuration in the specified vBridge 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. `CONFLICT' is set if this operation tries to map a host already mapped by another MAC mapping. `CONFLICT' is set if this operation tries to add a MAC address into `allowed-hosts' in the MAC mapping configuration, and that MAC address is already configured in `allowed-hosts'. `INTERNALERROR' is set if the operation failed due to internal error.
• container: input
• min elements: 0
• max elements: 2147483647
• uses: (urn:opendaylight:vtn:types)vbridge-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.
• min elements: 0
• max elements: 2147483647
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: acl-type
• description: The type of the target access control list. `ALLOW' indicates that the `allowed-hosts' container in the MAC mapping configuration should be modified. `DENY' indicates that the `denied-hosts' container in the MAC mapping configuration should be modified. Null is treated as if `ALLOW' is specified.
• min elements: 0
• max elements: 2147483647
• type: (urn:opendaylight:vtn:types)vtn-acl-type
• leaf: operation
• description: Describes how to update the specified access control list in the MAC mapping configuration. If `SET' is specified, the given list of host information will be applied to the specified access control list as specified. In other words, the specified access control list is cleared, and then the given host information will be added to the specified access control list. Note that MAC mapping will be removed if both `allowed-hosts' and `denied-hosts' container in the MAC mapping configuration become empty. If `ADD' is specified, the given list of host information will be added to the specified access control list in the MAC mapping configuration. If `REMOVE' is specified, the host information configured in the RPC input will be removed from the specified access conrol list in the MAC mapping configuration. Note that MAC mapping will be removed if both `allowed-hosts' and `denied-hosts' container in the MAC mapping configuration become empty. Null will be treated as if `ADD' is specified.
• min elements: 0
• max elements: 2147483647
• type: (urn:opendaylight:vtn:types)vtn-update-operation-type
• leaf-list: hosts
• description: A set of host information to be added to or removed from the access control list in the MAC mapping configuration. Duplicate hosts will be eliminated automatically.
• min elements: 0
• max elements: 2147483647
• type: vlan-host-desc
• 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

get-mac-mapped-host

• Description: Get a list of hosts where mapping is actually active based on MAC mapping configured in the specified vBridge. Upon successful completion, a list of host information is will be set to the RPC output. On failure, one of vtn-error-tag value which indicates the cause of error is set into application tag in RPC error. `BADREQUEST' is set if the RPC input contains invalid data. `NOTFOUND' is set if the VTN specified by `tenant-name' is not present. `NOTFOUND' is set if the vBridge specified by `tenant-name' and `bridge-name' 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)vbridge-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.
• min elements: 0
• max elements: 2147483647
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf-list: mac-addresses
• description: A list of MAC addresses to be searched. If this field is omitted or an empty list is specified, all the host information mapped to the specified vBridge by the MAC mapping will be set to the RPC output. Duplicates in this list will be eliminated automatically.
• min elements: 0
• max elements: 2147483647
• type: mac-address
• container: output
• min elements: 0
• max elements: 2147483647
• leaf: configured
• description: True is set only if the MAC mapping is configured in the vBridge specified by the RPC input.
• min elements: 0
• max elements: 2147483647
• type: (urn:ietf:params:xml:ns:yang:1)boolean
• list: mac-mapped-host
• description: A list of host information mapped to the specified vBridge by MAC mapping.
• min elements: 0
• max elements: 2147483647
• uses: (urn:opendaylight:vtn:vbridge:mac)vtn-mac-entry
• refines:
• leaf: mac-address
• description: A string representation of a learned MAC address.
• min elements: 0
• max elements: 2147483647
• 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.
• min elements: 0
• max elements: 2147483647
• 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.
• min elements: 0
• max elements: 2147483647
• type: ip-address
• 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