vtn-vterminal

Base Information

prefix	vterm
namespace	urn:opendaylight:vtn:vterminal
revision	2015-09-07
description	The module that describes the data models for vTerminal, which is isolated input and output terminal inside VTN.
yang-version	1
imports	vif:vtn-vinterface 2015-09-07; vbr:vtn-vbridge 2015-09-07; vtype:vtn-types 2015-02-09;

Groupings Summary

Name	Description
vtn-vterminal-info	Describes information about vTerminal. Unlike vBridge, vTerminal can have only one virtual interface. vTerminal is always used in conjunction with redirection by flow filter. `state' field indicates the state of the vTerminal. If any of the following conditions are met, the vTerminal status will be `UNKNOWN': - No virtual interface is configured in the vTerminal. - A virtual interface inside the vTerminal is disabled. - Port mapping is not configured in a virtual interface inside the vTerminal. `DOWN' indicates that the physical network mapped to the vTerminal is not operating correctly. If an enabled virtual interface inside the vTerminal is in `DOWN' state, then the vTerminal status will be `DOWN'. `UP indicates that the physical network mapped to the vTerminal is operating correctly.
vtn-vterminal-config	Describes configuration for a vTerminal.
vtn-vterminal-list	Describes a list of vTerminals.

RPCs Summary

Name	Description
update-vterminal	Create or modify the specified vTerminal. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `CREATED' indicates that the specified vTerminal has been newly created. `CHANGED' indicates that the configuration for the specified vTerminal has been changed. Null indicates that the configuration for the specified vTerminal 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 `update-mode' field in the RPC input is `MODIFY' and the specified vTerminal is not present. `CONFLICT' is set if `update-mode' field in the RPC input is `CREATE' and the specified vTerminal is present. `INTERNALERROR' is set if the operation failed due to internal error.
remove-vterminal	Remove the specified vTerminal. All the virtual interfaces inside the specified vTerminal will also be removed. 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 specified vTerminal is not present. `INTERNALERROR' is set if the operation failed due to internal error.

Name

Description

update-vterminal

Create or modify the specified vTerminal. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `CREATED' indicates that the specified vTerminal has been newly created. `CHANGED' indicates that the configuration for the specified vTerminal has been changed. Null indicates that the configuration for the specified vTerminal 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 `update-mode' field in the RPC input is `MODIFY' and the specified vTerminal is not present. `CONFLICT' is set if `update-mode' field in the RPC input is `CREATE' and the specified vTerminal is present. `INTERNALERROR' is set if the operation failed due to internal error.

remove-vterminal

Remove the specified vTerminal. All the virtual interfaces inside the specified vTerminal will also be removed. 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 specified vTerminal is not present. `INTERNALERROR' is set if the operation failed due to internal error.

Groupings

vtn-vterminal-info
- Description: Describes information about vTerminal. Unlike vBridge, vTerminal can have only one virtual interface. vTerminal is always used in conjunction with redirection by flow filter. `state' field indicates the state of the vTerminal. If any of the following conditions are met, the vTerminal status will be `UNKNOWN': - No virtual interface is configured in the vTerminal. - A virtual interface inside the vTerminal is disabled. - Port mapping is not configured in a virtual interface inside the vTerminal. `DOWN' indicates that the physical network mapped to the vTerminal is not operating correctly. If an enabled virtual interface inside the vTerminal is in `DOWN' state, then the vTerminal status will be `DOWN'. `UP indicates that the physical network mapped to the vTerminal is operating correctly.
vtn-vterminal-config
- Description: Describes configuration for a vTerminal.
vtn-vterminal-list
- Description: Describes a list of vTerminals.

RPC Definitions

update-vterminal

Description: Create or modify the specified vTerminal. Upon successful completion, the result of this operation will be set to the `status' field in the RPC output. `CREATED' indicates that the specified vTerminal has been newly created. `CHANGED' indicates that the configuration for the specified vTerminal has been changed. Null indicates that the configuration for the specified vTerminal 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 `update-mode' field in the RPC input is `MODIFY' and the specified vTerminal is not present. `CONFLICT' is set if `update-mode' field in the RPC input is `CREATE' and the specified vTerminal is present. `INTERNALERROR' is set if the operation failed due to internal error.

container: input

min elements: 0
max elements: 2147483647

uses: vtn-vterminal-config

refines:

uses: (urn:opendaylight:vtn:types)vterminal-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: terminal-name

description: The name of the vTerminal.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)string

leaf: update-mode

description: Describes how to update the vTerminal specified by `tenant-name' and `terminal-name'; If `UPDATE' is specified, the specified vTerminal is created if it is not present. Otherwise the specified vTerminal configuration is applied to the specified vTerminal. If `CREATE' is specified, the specified vTerminal is created only if it is not present. If the specified vTerminal is present, this operation will cause a `CONFLICT' error. If `MODIFY' is specified, the specified vTerminal configuration is applied to the specified vTerminal only if it is present. If the specified vTerminal is not present, this operation will cause a `NOTFOUND' error.
min elements: 0
max elements: 2147483647
type: update-mode
default: UPDATE

leaf: operation

description: Describes how to update the existing vTerminal specified by `tenant-name' and `terminal-name'. This field will be ignored if the specified vTerminal 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-vterminal-config' will be applied to the vTerminal configuration as-is. In this case the `description' field will be removed from the configuration if `description' field is omitted.
min elements: 0
max elements: 2147483647
type: operation
default: ADD

leaf: description

description: An arbitrary description about the vTerminal.
min elements: 0
max elements: 2147483647
type: (urn:ietf:params:xml:ns:yang:1)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-vterminal

Description: Remove the specified vTerminal. All the virtual interfaces inside the specified vTerminal will also be removed. 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 specified vTerminal is not present. `INTERNALERROR' is set if the operation failed due to internal error.