vtn-port-map

Base Information

prefix	portmap
namespace	urn:opendaylight:vtn:mapping:port
revision	2015-09-07
description	The module that describes the data models for port mapping, which associates a physical switch port with a virtual interface in VTN.
yang-version	1
imports	vtype:vtn-types 2015-02-09;

Groupings Summary

Name	Description
vtn-port-mappable	Describes the data model which can contain port mapping configuration.
vtn-port-map-config	Describes configuration for a port mapping. Actual physical port of switch that gets mapped to a virtual interface is decided as follows: - If `port-name' field is configured, then out of physical ports in the switch specified by `node' field, the physical port that has the specified port name will get mapped. - If `port-id' field is configured, the out of the physical ports in the switch specified by `node' field, the physical port corresponding to the specified port ID will get mapped. - If both `port-name' and `port-id' are configured, the out of the physical ports in the switch specified by `node' field, the physical port that has the specified port name and port ID will get mapped.

Name

Description

vtn-port-mappable

Describes the data model which can contain port mapping configuration.

vtn-port-map-config

Describes configuration for a port mapping. Actual physical port of switch that gets mapped to a virtual interface is decided as follows: - If `port-name' field is configured, then out of physical ports in the switch specified by `node' field, the physical port that has the specified port name will get mapped. - If `port-id' field is configured, the out of the physical ports in the switch specified by `node' field, the physical port corresponding to the specified port ID will get mapped. - If both `port-name' and `port-id' are configured, the out of the physical ports in the switch specified by `node' field, the physical port that has the specified port name and port ID will get mapped.

RPCs Summary

Name	Description
set-port-map	Configure port mapping in the specified virtual interface. The target virtual interface is determined by the RPC input. If `bridge-name' field in the RPC input is configured, port mapping is configured in the virtual interface attached to the vBridge specified by `tenant-name' and `bridge-name'. If `bridge-name' field is omitted and `terminal-name' field in the RPC input is configured, port mapping is configured in the virtual interface attached to the vTerminal specified by `tenant-name' and `terminal-name'. If port mapping is already configured in the specified virtual interface, the specified settins are applied after old configuration is deleted. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `CREATED' indicates that new port mapping configuration has been created successfully. `CHANGED' indicates that old port mapping configuration has been replaced with the configuration specified by the RPC input. Null indicates that the port mapping configuration specified by the RPC input is already applied to 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 vBridge specified by `tenant-name' and `bridge-name' is not present. `NOTFOUND' is set if the virtual interface specified by `tenant-name' and `bridge-name' (or `terminal-name') and `interface-name' is not present. `CONFLICT' is set if the specified combination of physical switch port and VLAN ID is mapped to another virtual interface. `INTERNALERROR' is set if the operation failed due to internal error.
remove-port-map	Remove port mapping configuration from the specified virtual interface. The target virtual interface is determined by the RPC input. If `bridge-name' field in the RPC input is configured, port mapping configured in the virtual interface attached to the vBridge specified by `tenant-name' and `bridge-name' will be removed. If `bridge-name' field is omitted and `terminal-name' field in the RPC input is configured, port mapping configured in the virtual interface attached to the vTerminal specified by `tenant-name' and `terminal-name' will be removed. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `REMOVED' indicates that port mapping configuration has been removed successfully from the virtual interface specified by the RPC input. Null indicates that port mapping configuration is not present in the virtual interface specified by the RPC input. 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 vBridge specified by `tenant-name' and `bridge-name' is not present. `NOTFOUND' is set if the virtual interface specified by `tenant-name' and `bridge-name' (or `terminal-name') and `interface-name' is not present. `INTERNALERROR' is set if the operation failed due to internal error.

Name

Description

set-port-map

Configure port mapping in the specified virtual interface. The target virtual interface is determined by the RPC input. If `bridge-name' field in the RPC input is configured, port mapping is configured in the virtual interface attached to the vBridge specified by `tenant-name' and `bridge-name'. If `bridge-name' field is omitted and `terminal-name' field in the RPC input is configured, port mapping is configured in the virtual interface attached to the vTerminal specified by `tenant-name' and `terminal-name'. If port mapping is already configured in the specified virtual interface, the specified settins are applied after old configuration is deleted. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `CREATED' indicates that new port mapping configuration has been created successfully. `CHANGED' indicates that old port mapping configuration has been replaced with the configuration specified by the RPC input. Null indicates that the port mapping configuration specified by the RPC input is already applied to 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 vBridge specified by `tenant-name' and `bridge-name' is not present. `NOTFOUND' is set if the virtual interface specified by `tenant-name' and `bridge-name' (or `terminal-name') and `interface-name' is not present. `CONFLICT' is set if the specified combination of physical switch port and VLAN ID is mapped to another virtual interface. `INTERNALERROR' is set if the operation failed due to internal error.

remove-port-map

Remove port mapping configuration from the specified virtual interface. The target virtual interface is determined by the RPC input. If `bridge-name' field in the RPC input is configured, port mapping configured in the virtual interface attached to the vBridge specified by `tenant-name' and `bridge-name' will be removed. If `bridge-name' field is omitted and `terminal-name' field in the RPC input is configured, port mapping configured in the virtual interface attached to the vTerminal specified by `tenant-name' and `terminal-name' will be removed. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `REMOVED' indicates that port mapping configuration has been removed successfully from the virtual interface specified by the RPC input. Null indicates that port mapping configuration is not present in the virtual interface specified by the RPC input. 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 vBridge specified by `tenant-name' and `bridge-name' is not present. `NOTFOUND' is set if the virtual interface specified by `tenant-name' and `bridge-name' (or `terminal-name') and `interface-name' is not present. `INTERNALERROR' is set if the operation failed due to internal error.

Groupings

vtn-port-mappable
- Description: Describes the data model which can contain port mapping configuration.
vtn-port-map-config
- Description: Describes configuration for a port mapping. Actual physical port of switch that gets mapped to a virtual interface is decided as follows: - If `port-name' field is configured, then out of physical ports in the switch specified by `node' field, the physical port that has the specified port name will get mapped. - If `port-id' field is configured, the out of the physical ports in the switch specified by `node' field, the physical port corresponding to the specified port ID will get mapped. - If both `port-name' and `port-id' are configured, the out of the physical ports in the switch specified by `node' field, the physical port that has the specified port name and port ID will get mapped.

RPC Definitions

set-port-map

Description: Configure port mapping in the specified virtual interface. The target virtual interface is determined by the RPC input. If `bridge-name' field in the RPC input is configured, port mapping is configured in the virtual interface attached to the vBridge specified by `tenant-name' and `bridge-name'. If `bridge-name' field is omitted and `terminal-name' field in the RPC input is configured, port mapping is configured in the virtual interface attached to the vTerminal specified by `tenant-name' and `terminal-name'. If port mapping is already configured in the specified virtual interface, the specified settins are applied after old configuration is deleted. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `CREATED' indicates that new port mapping configuration has been created successfully. `CHANGED' indicates that old port mapping configuration has been replaced with the configuration specified by the RPC input. Null indicates that the port mapping configuration specified by the RPC input is already applied to 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 vBridge specified by `tenant-name' and `bridge-name' is not present. `NOTFOUND' is set if the virtual interface specified by `tenant-name' and `bridge-name' (or `terminal-name') and `interface-name' is not present. `CONFLICT' is set if the specified combination of physical switch port and VLAN ID is mapped to another virtual interface. `INTERNALERROR' is set if the operation failed due to internal error.

container: input

min elements: 0
max elements: 2147483647

uses: vtn-port-map-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: 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

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

remove-port-map

Description: Remove port mapping configuration from the specified virtual interface. The target virtual interface is determined by the RPC input. If `bridge-name' field in the RPC input is configured, port mapping configured in the virtual interface attached to the vBridge specified by `tenant-name' and `bridge-name' will be removed. If `bridge-name' field is omitted and `terminal-name' field in the RPC input is configured, port mapping configured in the virtual interface attached to the vTerminal specified by `tenant-name' and `terminal-name' will be removed. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `REMOVED' indicates that port mapping configuration has been removed successfully from the virtual interface specified by the RPC input. Null indicates that port mapping configuration is not present in the virtual interface specified by the RPC input. 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 vBridge specified by `tenant-name' and `bridge-name' is not present. `NOTFOUND' is set if the virtual interface specified by `tenant-name' and `bridge-name' (or `terminal-name') and `interface-name' is not present. `INTERNALERROR' is set if the operation failed due to internal error.