vtn-path-map

Base Information

prefix pathmap
namespace urn:opendaylight:vtn:pathmap
revision 2015-03-28
description The module that describes the path map configuration.
yang-version 1
imports vtype:vtn-types 2015-02-09;

Groupings Summary

Name Description
vtn-path-map-list A container that holds a list of path map configurations.
vtn-path-map-config Describes configuration for a path map. If `idle-timeout' field is configured, `hard-timeout' field also needs to be configured. If both `idle-timeout' and `hard-timeout' fields contain non-zero values, the value configured in `hard-timeout' needs to be greater than the value configured in `idle-timeout'.
vtn-path-map-result Describes a pair of path map index and `vtn-update-type'. This grouping is used as output of RPC that modifies the global or VTN path map configuration.

Child Nodes Summary

Name Description
global-path-maps The root container of all the global path map configurations. Global path maps affect flows in all VTNs, but the VTN path maps are always evaluated prior to the global path maps. Global path maps will be evaluated only if a packet does not match any VTN path map. Note that the path map configuration must be modified by RPC. Do not edit this container directly.

RPCs Summary

Name Description
set-path-map Create or modify the global or VTN path map. This operation takes a list of `vtn-path-map-config', and put all configurations into the specified path map list. If the name of the VTN is specified, the given path maps are configured as the VTN path map. Otherwise they are configured as the global path map. Path map indices specified in the RPC input will be copied to the RPC output, and `status' field in `vtn-path-map-result' describes the result of the operation. `CREATED' indicates that the path map configuration specified by the index value has been newly created. `CHANGED' indicates that the path map configuration specified by the index value has been successfully changed. Null indicates that the path map configuration specified by the index value 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 the name is not present. `INTERNALERROR' is set if the operation failed due to internal error.
clear-path-map Remove all the path map configurations present in the global or VTN path map container. `status' in RPC output descripts the result of the operation. `REMOVED' indicates that at least one path map in the specified path map container has been removed. Null indicates that no configuration is present in the specified path map. 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 the name is not present. `INTERNALERROR' is set if the operation failed due to internal error.
remove-path-map Remove the path map configuration in the global or VTN path map. Values passed to `map-index' list will be copied to the RPC output, and `status' field in `vtn-path-map-result' describes the result of the operation. `REMOVED' indicates that the path map associated with the map index has been successfully removed. Null indicates that the path map is not associated with the map index in the specified path map. 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 the name is not present. `INTERNALERROR' is set if the operation failed due to internal error.

Groupings

Datastore Structure

vtn-path-map

Child nodes

Direct children

global-path-maps

XML Path
Restconf path
vtn-path-map:global-path-maps

Direct children

XML example

        <global-path-maps xmlns="urn:opendaylight:vtn:pathmap">
        
            <!-- See definition
             for child nodes.  -->
            <!-- This node could appear multiple times -->
            <vtn-path-map xmlns="urn:opendaylight:vtn:pathmap">...</vtn-path-map>
        
        </global-path-maps>

global-path-maps/vtn-path-map

XML Path
Restconf path
vtn-path-map:global-path-maps/vtn-path-map/{index}

Direct children

XML example

        <vtn-path-map xmlns="urn:opendaylight:vtn:pathmap">
        
            <condition xmlns="urn:opendaylight:vtn:pathmap">...</condition>
        
            <policy xmlns="urn:opendaylight:vtn:pathmap">...</policy>
        
            <index xmlns="urn:opendaylight:vtn:pathmap">...</index>
        
            <idle-timeout xmlns="urn:opendaylight:vtn:pathmap">...</idle-timeout>
        
            <hard-timeout xmlns="urn:opendaylight:vtn:pathmap">...</hard-timeout>
        
        </vtn-path-map>

RPC Definitions

set-path-map

clear-path-map

remove-path-map