vtn-vlan-map

Base Information

prefix vlanmap
namespace urn:opendaylight:vtn:mapping:vlan
revision 2015-09-07
description The module that describes the data models for VLAN mapping, which associates a VLAN with a vBridge in VTN.
yang-version 1
imports inv:opendaylight-inventory 2013-08-19; vtype:vtn-types 2015-02-09;

Groupings Summary

Name Description
vtn-vlan-map-config Describes configuration for a VLAN mapping.
vtn-vlan-mappable Describes the data model which can contain VLAN mapping configuration.
vtn-vlan-map-info Describes information about VLAN mapping, which associates a VLAN with a vBridge in VTN.
vtn-vlan-map-status Describes runtime status information about VLAN mapping.

RPCs Summary

Name Description
add-vlan-map Configure VLAN mapping in the specified vBridge. VLAN specified by the RPC input will get mapped to the specified vBridge. Upon successful completion, the identifier assigned to the configured VLAN mapping and status status information about the VLAN mapping are set into 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. `CONFLICT' is set if the VLAN network speccified by the RPC input is already mapped to the specified vBridge or another vBridge. `INTERNALERROR' is set if the operation failed due to internal error.
get-vlan-map Search for a VLAN mapping with the specified VLAN mapping configuration in the specified vBridge. If a VLAN mapping with the VLAN mapping configuration that exactly matches with the configuration specified by the RPC input is present in the specified vBridge, identifier assigned to that VLAN mapping and status information about the VLAN mapping are set to the RPC output. The RPC output will be empty if not found. 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.
remove-vlan-map Remove the specified VLAN mappings from the vBridge. IDs for VLAN mappings passed to `map-ids' list will be copied to the RPC output, and `status' field in the RPC output describes the result of the operation. `REMOVED' indicates that the VLAN mapping specified by `map-id' field in the RPC output has been removed. Null indicates that the VLAN mapping specified by `map-id' field in the RPC output is not present. If no VLAN mapping ID is specified by the RPC input, all the VLAN mappings in the specified vBridge will be removed. In this case IDs for all the removed VLAN mappings will be copied to the RPC output. `remove-vlan-map-result' in the RPC output will be null if no VLAN mapping ID is specified by the RPC input and no VLAN mapping is configured in the specified vBridge. 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.

Groupings

RPC Definitions

add-vlan-map

get-vlan-map

remove-vlan-map