vtn-vinterface

Base Information

prefix	vif
namespace	urn:opendaylight:vtn:vinterface
revision	2015-09-07
description	The module that describes the data models for virtual interface, which is an input and output interface that could be set in virtual node in VTN.
yang-version	1
imports	inv:opendaylight-inventory 2013-08-19; vtype:vtn-types 2015-02-09; vfilter:vtn-flow-filter 2015-09-07; portmap:vtn-port-map 2015-09-07;

Groupings Summary

Name	Description
vtn-mappable-vinterface-list	Describes a list of virtual interfaces which can have port mapping confuguration.
vtn-vinterface-config	Describes configuration for a virtual interface.
vtn-mappable-vinterface	Describes information about a virtual interface which can contain port mapping configuration.
vtn-vinterface-info	Describes information about virtual interface.
vtn-mappable-vinterface-status	Describes runtime status information about a virtual interface which can contain port mapping configuration.

RPCs Summary

Name	Description
update-vinterface	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.
remove-vinterface	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.

Name

Description

update-vinterface

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.

remove-vinterface

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.

Groupings

vtn-mappable-vinterface-list
- Description: Describes a list of virtual interfaces which can have port mapping confuguration.
vtn-vinterface-config
- Description: Describes configuration for a virtual interface.
vtn-mappable-vinterface
- Description: Describes information about a virtual interface which can contain port mapping configuration.
vtn-vinterface-info
- Description: Describes information about virtual interface.
vtn-mappable-vinterface-status
- Description: Describes runtime status information about a virtual interface which can contain port mapping configuration.

RPC Definitions

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

uses: vtn-vinterface-config

refines:

uses: (urn:opendaylight:vtn:types)vnode-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. This field is omitted if the virtual node specified by this model is neither a vBridge nor a virtual node attached to the vBridge.
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.
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.
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.
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.
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).
type: operation
default: ADD

leaf: description

description: An arbitrary description about the virtual interface.
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.
type: (urn:ietf:params:xml:ns:yang:1)boolean

container: output

uses: (urn:opendaylight:vtn:types)vtn-rpc-result

refines:

leaf: status

description: Describes the status of the RPC result.
type: (urn:opendaylight:vtn:types)vtn-update-type

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.