blob: ee920b1d6c3c8625bb5daf32f9ad98e91afdf3ee [file] [log] [blame]
Scott Bakerc9d3d842021-09-17 11:32:53 -07001// SPDX-FileCopyrightText: 2021 Open Networking Foundation
2//
Sean Condon160ec1d2022-02-08 12:58:25 +00003// SPDX-License-Identifier: Apache-2.0
Scott Bakerc9d3d842021-09-17 11:32:53 -07004
5module ip-domain {
6 namespace "http://opennetworking.org/aether/ip-domain";
7 prefix ipd;
8
9 import ietf-inet-types { prefix inet; }
10 import aether-types { prefix at; }
11 import enterprise{ prefix ent; }
12 import ietf-yang-types{ prefix yg; }
13
14 organization "Open Networking Foundation.";
15 contact "Scott Baker";
16 description
17 "An Aether IP-Domain. This is a list of available subnets
18 that may be assigned to UEs, as well as DNS servers and other
19 metadata";
20
21 revision "2021-06-02" {
22 description "An Aether IP and Domain Specification";
23 reference "RFC 6087";
24 }
25
26 typedef ip-domain-id {
27 type yg:yang-identifier {
28 length 1..32;
29 }
PUSHP RAJba2e32f2021-11-02 10:39:24 +000030 description "The typedef for ip-domain-id";
Scott Bakerc9d3d842021-09-17 11:32:53 -070031 }
32
33 container ip-domain {
34 description "The top level container";
35
36 list ip-domain {
37 key "id";
38 description
39 "List of ip domains";
40
41 leaf id {
42 type ip-domain-id;
43 description "ID for this ip domain.";
44 }
45
46 leaf display-name {
47 type string {
48 length 1..80;
49 }
50 description "display name to use in GUI or CLI";
51 }
52
53 leaf dnn {
54 type at:dnn;
55 description "DNN/APN";
PUSHP RAJba2e32f2021-11-02 10:39:24 +000056 }
Scott Bakerc9d3d842021-09-17 11:32:53 -070057
58 leaf dns-primary {
59 type inet:ip-address;
60 description "primary dns server name";
61 }
62
63 leaf dns-secondary {
64 type inet:ip-address;
65 description "secondary dns server name";
66 }
67
68 // Note: Cannot use a subnet as a list key. Dropped support from a
69 // list of subnets to a single subnet. Revisit in the future.
70 leaf subnet {
71 type inet:ipv4-prefix;
72 mandatory true;
73 description "subnet to allocate ip addresses from";
74 }
75
76 leaf admin-status {
77 type at:admin-status;
78 description "administrative status";
79 }
80
81 leaf mtu {
82 type at:mtu;
83 description "maximum transmission unit";
PUSHP RAJba2e32f2021-11-02 10:39:24 +000084 }
Scott Bakerc9d3d842021-09-17 11:32:53 -070085
86 leaf description {
87 type at:description;
88 description "description of this ip domain";
89 }
90
91 // Ip-Domain is always owned by an Enterprise, because it contains
92 // IP addresses relative to that Enterprise.
93 leaf enterprise {
94 type leafref {
95 path "/ent:enterprise/ent:enterprise/ent:id";
96 }
97 mandatory true;
98 description
99 "Link to enterprise that owns this IP-Domain";
PUSHP RAJba2e32f2021-11-02 10:39:24 +0000100 }
Scott Bakerc9d3d842021-09-17 11:32:53 -0700101 }
PUSHP RAJba2e32f2021-11-02 10:39:24 +0000102 }
Scott Bakerc9d3d842021-09-17 11:32:53 -0700103}