vtn-path-map

Base Information

Groupings Summary

Child Nodes Summary

RPCs Summary

Groupings

• vtn-path-map-list

  • Description: A container that holds a list of path map configurations.
  • list: vtn-path-map
  • description: A list of path maps.
  • key definition: index
  • uses: vtn-path-map-config
  • refines:
  • leaf: condition
  • description: The name of the flow condition that selects packets. This path map is invalidated if the flow condition specified by this field is not present.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: policy
  • description: The identifier of the path policy which determines the route of packets. This path map is invalidated if the path policy specified by this field is not present. Zero specifies the system default path policy which minimizes the number of hops in the packet route. If omitted, it will be treated as if zero is specified.
  • type: policy
  • default: 0
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • type: (urn:opendaylight:vtn:types)int32
  • leaf: idle-timeout
  • description: The number of seconds to be set to `idle-timeout' field in flow entries. Zero means an infinite time.
  • type: (urn:ietf:params:xml:ns:yang:1)uint16
  • leaf: hard-timeout
  • description: The number of seconds to be set to `hard-timeout' field in flow entries. Zero means an infinite time.
  • type: (urn:ietf:params:xml:ns:yang:1)uint16

• vtn-path-map-config

  • Description: 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'.
  • leaf: index
  • description: The index value that determines the order of elements in a list.
  • type: (urn:opendaylight:vtn:types)int32
  • leaf: condition
  • description: The name of the flow condition that selects packets. This path map is invalidated if the flow condition specified by this field is not present.
  • type: (urn:opendaylight:vtn:types)vnode-name
  • leaf: policy
  • description: The identifier of the path policy which determines the route of packets. This path map is invalidated if the path policy specified by this field is not present. Zero specifies the system default path policy which minimizes the number of hops in the packet route. If omitted, it will be treated as if zero is specified.
  • type: policy
  • default: 0
  • leaf: idle-timeout
  • description: The number of seconds to be set to `idle-timeout' field in flow entries. Zero means an infinite time.
  • type: (urn:ietf:params:xml:ns:yang:1)uint16
  • leaf: hard-timeout
  • description: The number of seconds to be set to `hard-timeout' field in flow entries. Zero means an infinite time.
  • type: (urn:ietf:params:xml:ns:yang:1)uint16

• vtn-path-map-result

  • Description: 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.
  • leaf: index
  • description: The index value that specifies the flow match in the flow condition.
  • type: (urn:ietf:params:xml:ns:yang:1)int32
  • leaf: status
  • description: Describes the status of the RPC result.
  • type: (urn:opendaylight:vtn:types)vtn-update-type

Datastore Structure

• global-path-maps
  • vtn-path-map [index] (U)
    • condition(U)
    • policy(U)
    • index(U)
    • idle-timeout(U)
    • hard-timeout(U)

Child nodes

Direct children

• global-path-maps (container)
  • configuration data: false

global-path-maps

XML Path

Restconf path

vtn-path-map:global-path-maps

Direct children

• vtn-path-map (list)
  • configuration data: false

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

• condition (leaf)
  • configuration data: false
  • mandatory: true
• policy (leaf)
  • configuration data: false
  • mandatory: false
• index (leaf)
  • configuration data: false
  • mandatory: false
• idle-timeout (leaf)
  • configuration data: false
  • mandatory: false
• hard-timeout (leaf)
  • configuration data: false
  • mandatory: false

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

remove-path-map

• Description: 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.
• container: input
• leaf: tenant-name
• description: The name of the VTN. If this field is specified, path maps specified in the RPC input will be removed from the VTN path map configuration. If this field is omitted, path maps specified in the RPC input will be removed from the global path map configuration.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf-list: map-index
• description: A list of path map indices to be removed from the path map configuration specified by `tenant-name' field. Duplicates in this list will be eliminated automatically.
• type: int32
• container: output
• list: remove-path-map-result
• description: Describes pairs of path map indices passed to the RPC input and results.
• uses: vtn-path-map-result
• refines:
• leaf: index
• description: The index value that specifies the flow match in the flow condition.
• type: (urn:ietf:params:xml:ns:yang:1)int32
• leaf: status
• description: Describes the status of the RPC result.
• type: (urn:opendaylight:vtn:types)vtn-update-type

set-path-map

• Description: 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.
• container: input
• leaf: tenant-name
• description: The name of the VTN. If this field is specified, the specified path map will affect flows only in the specified VTN. If this field is omitted, the specified path map will affect flows in all the VTNs.
• type: (urn:ietf:params:xml:ns:yang:1)string
• list: path-map-list
• description: A list of `vtn-path-map-config' to be applied to the path map configuration. Note that a duplicate match index in this list will cause a `BADREQUEST' error.
• uses: vtn-path-map-config
• refines:
• leaf: condition
• description: The name of the flow condition that selects packets. This path map is invalidated if the flow condition specified by this field is not present.
• type: (urn:opendaylight:vtn:types)vnode-name
• leaf: policy
• description: The identifier of the path policy which determines the route of packets. This path map is invalidated if the path policy specified by this field is not present. Zero specifies the system default path policy which minimizes the number of hops in the packet route. If omitted, it will be treated as if zero is specified.
• type: policy
• default: 0
• leaf: index
• description: The index value that determines the order of elements in a list.
• type: (urn:opendaylight:vtn:types)int32
• leaf: idle-timeout
• description: The number of seconds to be set to `idle-timeout' field in flow entries. Zero means an infinite time.
• type: (urn:ietf:params:xml:ns:yang:1)uint16
• leaf: hard-timeout
• description: The number of seconds to be set to `hard-timeout' field in flow entries. Zero means an infinite time.
• type: (urn:ietf:params:xml:ns:yang:1)uint16
• container: output
• list: set-path-map-result
• description: Describes pairs of path map indices passed to the RPC input and results.
• uses: vtn-path-map-result
• refines:
• leaf: index
• description: The index value that specifies the flow match in the flow condition.
• type: (urn:ietf:params:xml:ns:yang:1)int32
• leaf: status
• description: Describes the status of the RPC result.
• type: (urn:opendaylight:vtn:types)vtn-update-type

clear-path-map

• Description: 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.
• container: input
• leaf: tenant-name
• description: The name of the VTN. If this field is specified, all path map configurations present in the specified VTN will be removed. If this field is omitted, all global path map configurations will be removed.
• type: (urn:ietf:params:xml:ns:yang:1)string
• 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