1 module network-topology-pcep {
2 // vi: set et smarttab sw=4 tabstop=4:
4 namespace "urn:opendaylight:params:xml:ns:yang:topology:pcep";
7 import ietf-inet-types { prefix inet; revision-date 2013-07-15; }
8 import network-topology { prefix nt; revision-date 2013-10-21; }
9 import odl-network-topology { prefix ont; revision-date 2014-01-13; }
10 import pcep-types { prefix pcep; revision-date 2013-10-05; }
11 import rsvp { prefix rsvp; revision-date 2015-08-20; }
13 organization "Cisco Systems, Inc.";
14 contact "Robert Varga <rovarga@cisco.com>";
17 "This module contains the PCEP extensions to base topology model. It
18 exposes the LSPs for which a particular node is the head end.
20 This module exposes three programming instructions,add-lsp,
21 remove-lsp and update-lsp, which map to actively-stateful PCEP
22 operations using PCInitiate and PCUpd messages to initiate,
23 destroy and udpate LSP configuration. The lifecycle of these
24 instructions follows draft-crabbe-pce-pce-initiated-lsp and
25 draft-ietf-pce-stateful-pce, completing execution once the head-end
26 router has acknowledged operation success. Should the router become
27 disconnected, the instruction resolve to Cancelled if the message
28 has not been sent into the TCP socket, or Failed it they have.
30 Copyright (c)2013 Cisco Systems, Inc. All rights reserved.
32 This program and the accompanying materials are made available
33 under the terms of the Eclipse Public License v1.0 which
34 accompanies this distribution, and is available at
35 http://www.eclipse.org/legal/epl-v10.html";
37 revision "2013-10-24" {
43 typedef pcc-sync-state {
47 "Initial state resynchronization is being performed.";
49 enum incremental-sync {
51 "Incremental state resynchronization is being performed.";
53 enum triggered-initial-sync {
55 "Triggered initial state resynchronization is being performed.";
57 enum pcep-triggered-resync {
59 "Pcep triggered state resynchronization is being performed.";
63 "State synchronization has been achieved.";
68 grouping topology-pcep-type {
69 container topology-pcep {
70 presence "indicates a PCEP-aware topology";
74 augment "/nt:network-topology/nt:topology/nt:topology-types" {
75 uses topology-pcep-type;
78 grouping pcep-client-attributes {
79 description "Data present in a node which is a PCEP client (PCC).";
81 container path-computation-client {
83 "PCC-related run-time information. This container is only
84 present when the node is connected through PCEP in a PCC
90 "IP address which the node used to connected to the PCE.
91 There are no guarantees as to reachability of the address,
92 nor its relationship to other control, management, or
93 data plane addresses.";
98 container stateful-tlv {
104 when "../stateful-tlv";
120 uses pcep:path-definition;
127 augment "/nt:network-topology/nt:topology/nt:node" {
128 when "../../nt:topology-types/topology-pcep";
130 uses pcep-client-attributes;
133 typedef failure-type {
135 "Enumeration of all the distinct failure modes that can
136 happen while servicing a request towards the PCC.";
141 "The request failed before it was sent to the PCC.
142 PCC's state is guaranteed not to reflect state
143 transition implied by the request. This typically
144 happens if the request is syntactically invalid,
145 the target PCC is not connected or disconnects
146 while the request is enqueued.";
150 "The request has been sent to the PCC, but either the
151 session went down before we have received confirmation
152 of the request being received by the PCC, or the request
153 timed-out waiting for response from PCC. PCC's state is
154 unknown -- the request may or may not be reflected
155 in its internal state. The caller should not make
156 any hard assumptions about PCC state until it reconnects
157 and state synchronization completes.";
161 "The request has been seen by the PCC, where it failed
162 for some external reason. The caller can assume the
163 state transition has not taken place, but is advised
164 to examine the attached error list to gain a deeper
165 understanding of the failure cause.";
182 grouping operation-result {
188 when "../failure = failed";
189 uses pcep:pcep-error-object;
193 grouping lsp-metadata {
197 "Container for external metadata attached to the LSP. Contents of this container
198 are not propagated onto the router itself, so it is persisted only while the LSP
203 grouping add-lsp-args {
206 container arguments {
208 uses pcep:endpoints-object;
210 uses pcep:path-definition;
218 uses ont:network-topology-reference;
222 uses operation-result;
226 grouping remove-lsp-args {
232 uses ont:network-topology-reference;
233 uses remove-lsp-args;
236 uses operation-result;
240 grouping update-lsp-args {
243 container arguments {
245 uses pcep:path-definition;
253 uses ont:network-topology-reference;
254 uses update-lsp-args;
257 uses operation-result;
261 grouping ensure-lsp-operational-args {
264 container arguments {
269 rpc ensure-lsp-operational {
271 "Ensure that the target LSP is provisioned and has specified
272 operational status.";
275 uses ont:network-topology-reference;
276 uses ensure-lsp-operational-args;
279 uses operation-result;
283 grouping trigger-sync-args {
293 uses ont:network-topology-reference;
294 uses trigger-sync-args;
297 uses operation-result;