blob: 3c5672264f2305c162bf7a19af9a2f054ebb0147 [file] [log] [blame]
Scott Bakerc9d3d842021-09-17 11:32:53 -07001// SPDX-FileCopyrightText: 2021 Open Networking Foundation
2//
3// SPDX-License-Identifier: LicenseRef-ONF-Member-Only-1.0
4
5module upf {
6 namespace "http://opennetworking.org/aether/upf";
7 prefix upf;
8
9 import aether-types { prefix at; }
10 import ietf-inet-types { prefix inet; }
11 import enterprise{ prefix ent; }
12 import ietf-yang-types{ prefix yg; }
13
14 organization "Open Networking Foundation.";
15 contact "Scott Baker";
16 description "A Aether UPF List is a named User Plane Function.";
17
18 revision "2021-06-02" {
19 description "An Aether User Plane Function";
20 reference "RFC 6087";
21 }
22
23 typedef upf-id {
24 type yg:yang-identifier {
25 length 1..32;
26 }
PUSHP RAJba2e32f2021-11-02 10:39:24 +000027 description "The typedef for upf-id";
Scott Bakerc9d3d842021-09-17 11:32:53 -070028 }
29
30 container upf {
31 description "The top level container";
32
33 list upf {
34 key "id";
35 description
36 "A list of named upfs.";
37
38 leaf id {
39 type upf-id;
40 description "ID for this upf.";
41 }
42
43 leaf address {
44 type inet:host;
45 mandatory true;
46 description
47 "Address of UPF";
48 }
49
50 leaf port {
51 type inet:port-number;
52 mandatory true;
53 description
54 "Port for UPF";
55 }
56
57 leaf display-name {
58 type string {
59 length 1..80;
60 }
61 description "display name to use in GUI or CLI";
62 }
63
64 leaf description {
65 type at:description;
66 description "description of this UPF";
67 }
68
69 // UPFs are always owned by an Enterprise, since they typically exist on the
70 // Enterprise's edge. TODO: Consider whether they should be owned by a Site
71 // instead of Enterprise.
72 leaf enterprise {
73 type leafref {
74 path "/ent:enterprise/ent:enterprise/ent:id";
75 }
76 mandatory true;
77 description
78 "Link to enterprise that owns this Access Point List";
PUSHP RAJba2e32f2021-11-02 10:39:24 +000079 }
Scott Bakerc9d3d842021-09-17 11:32:53 -070080 }
PUSHP RAJba2e32f2021-11-02 10:39:24 +000081 }
Scott Bakerc9d3d842021-09-17 11:32:53 -070082}